org.eclipse.smila.security.processing
Class SampleSecurityConverterPipelet

java.lang.Object
  org.eclipse.smila.security.processing.SampleSecurityConverterPipelet

All Implemented Interfaces:

Pipelet

public class SampleSecurityConverterPipelet
extends java.lang.Object
implements Pipelet

Sample Security Converter Pipelet.

Nested Class Summary

static class

SampleSecurityConverterPipelet.ExecutionMode Types of execution modes this service supports.

Field Summary

static java.lang.String	EXECUTION_MODE name of annotation configuring the type of execution.
static java.lang.String	PROP_READ_USERS_ATTRIBUTE_NAME Constant for the property readUsersAttributeName.
static java.lang.String	PROP_RESOLVE_GROUPS Constant for the property resolveGroups.
static java.lang.String	PROP_RESOLVE_USER_NAMES Constant for the property resolveUserNames.
static java.lang.String	PROP_RESOLVED_USER_NAME_PROPERTY_NAME Constant for the property resolvedUserNamePropertyName.

Constructor Summary

SampleSecurityConverterPipelet()

Method Summary

void	configure(AnyMap configuration) Reads the configuration.
java.lang.String[]	process(Blackboard blackboard, java.lang.String[] recordIds) process records on Blackboard service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_READ_USERS_ATTRIBUTE_NAME

public static final java.lang.String PROP_READ_USERS_ATTRIBUTE_NAME

Constant for the property readUsersAttributeName.

See Also:

Constant Field Values

PROP_RESOLVE_GROUPS

public static final java.lang.String PROP_RESOLVE_GROUPS

Constant for the property resolveGroups.

See Also:

Constant Field Values

PROP_RESOLVE_USER_NAMES

public static final java.lang.String PROP_RESOLVE_USER_NAMES

Constant for the property resolveUserNames.

See Also:

Constant Field Values

PROP_RESOLVED_USER_NAME_PROPERTY_NAME

public static final java.lang.String PROP_RESOLVED_USER_NAME_PROPERTY_NAME

Constant for the property resolvedUserNamePropertyName.

See Also:

Constant Field Values

EXECUTION_MODE

public static final java.lang.String EXECUTION_MODE

name of annotation configuring the type of execution.

See Also:

Constant Field Values

Constructor Detail

SampleSecurityConverterPipelet

public SampleSecurityConverterPipelet()

Method Detail

configure

public void configure(AnyMap configuration)
               throws ProcessingException

Reads the configuration. set configuration of pipelet. called once after instantiation before the pipelet is actually used in a workflow.

Specified by:

configure in interface Pipelet

Parameters:

configuration - configuration of pipelet.

Throws:

ProcessingException - configuration is not applicable for pipelet (missing properties, wrong datatypes)

process

public java.lang.String[] process(Blackboard blackboard,
                                  java.lang.String[] recordIds)
                           throws ProcessingException

process records on Blackboard service.

Specified by:

process in interface Pipelet

Parameters:

blackboard - Blackboard service managing the records.

recordIds - Ids of records to process.

Returns:

Ids of result records. By default this should be the same as the passed in recordIds unless there is a specific reason not to do so. This is especially true for SearchPiplets.

Throws:

ProcessingException - error during processing.