SMILA (incubation) API documentation

org.eclipse.smila.security.processing
Class SampleSecurityConverter

java.lang.Object
  extended by org.eclipse.smila.security.processing.SampleSecurityConverter
All Implemented Interfaces:
ProcessingService

public class SampleSecurityConverter
extends java.lang.Object
implements ProcessingService

Sample Security Converter Index Service.


Nested Class Summary
static class SampleSecurityConverter.ExecutionMode
          Types of execution modes this service supports.
 
Field Summary
static java.lang.String BUNDLE_NAME
          name of bundle.
static java.lang.String CONFIG_FILE
          name of configuration file.
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.
 
Fields inherited from interface org.eclipse.smila.processing.ProcessingService
PROPERTY_NAME
 
Constructor Summary
SampleSecurityConverter()
           
 
Method Summary
protected  void activate(ComponentContext context)
          DS activate method.
protected  void deactivate(ComponentContext context)
          DS deactivate method.
 Id[] process(Blackboard blackboard, Id[] recordIds)
          process records on Blackboard service.
 void setSecurityResolver(SecurityResolver securityResolver)
          Sets the _securityResolver.
 void unsetSecurityResolver(SecurityResolver securityResolver)
          Set the _securityResolver to null.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME
name of bundle. Used in configuration reading.

See Also:
Constant Field Values

CONFIG_FILE

public static final java.lang.String CONFIG_FILE
name of configuration file. Hardcoded for now (or fallback), configuration properties should be received from configuration service later.

See Also:
Constant Field Values

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

SampleSecurityConverter

public SampleSecurityConverter()
Method Detail

activate

protected void activate(ComponentContext context)
                 throws java.lang.Exception
DS activate method.

Parameters:
context - ComponentContext
Throws:
java.lang.Exception - if any error occurs

deactivate

protected void deactivate(ComponentContext context)
                   throws java.lang.Exception
DS deactivate method.

Parameters:
context - the ComponentContext
Throws:
java.lang.Exception - if any error occurs

setSecurityResolver

public void setSecurityResolver(SecurityResolver securityResolver)
Sets the _securityResolver. Used by OSGi Declarative Services.

Parameters:
securityResolver - the SecurityResolver to set

unsetSecurityResolver

public void unsetSecurityResolver(SecurityResolver securityResolver)
Set the _securityResolver to null. Used by OSGi Declarative Services.

Parameters:
securityResolver - the SecurityResolver to unset

process

public Id[] process(Blackboard blackboard,
                    Id[] recordIds)
             throws ProcessingException
process records on Blackboard service.

Specified by:
process in interface ProcessingService
Parameters:
blackboard - Blackboard service managing the records.
recordIds - Ids of records to process.
Returns:
Ids of result records.
Throws:
ProcessingException - error during processing.
See Also:
ProcessingService.process(Blackboard, Id[])

SMILA (incubation) API documentation