org.eclipse.scada.core.server.common

Class ServiceCommon<S extends Session,SI extends AbstractSessionImpl>

java.lang.Object

org.eclipse.scada.core.server.common.ServiceCommon<S,SI>

All Implemented Interfaces:

Service<S>, LifecycleAware

Direct Known Subclasses:

AbstractServiceImpl, HiveCommon

public abstract class ServiceCommon<S extends Session,SI extends AbstractSessionImpl>
extends Object
implements Service<S>

Field Summary

Fields

Modifier and Type	Field and Description
protected static AuthorizationResult	DEFAULT_RESULT

Constructor Summary

Constructors

Constructor and Description
ServiceCommon()

Method Summary

Methods

Modifier and Type	Method and Description
protected NotifyFuture<AuthorizationReply>	authorize(AuthorizationRequest request, CallbackHandler callbackHandler)
protected NotifyFuture<AuthorizationReply>	authorize(AuthorizationRequest request, CallbackHandler callbackHandler, AuthorizationResult defaultResult) Authorize an operation
protected Set<String>	extractPrivileges(Properties properties)
protected void	fillSessionProperties(UserInformation userInformation, Map<String,String> sessionResultProperties)
protected NotifyFuture<UserInformation>	loginUser(Properties properties, Map<String,Object> contextInformation, CallbackHandler callbackHandler) Wraps the call to #authenticate(Properties) so that the correct exceptions are thrown for a #createSession(Properties) call.
protected NotifyFuture<UserInformation>	makeEffectiveUserInformation(AbstractSessionImpl session, String targetUser, CallbackHandler handler)
void	setAuditLogService(AuditLogService auditLogService)
protected void	setAuthenticationImplementation(AuthenticationImplementation authenticationImplementation)
protected void	setAuthorizationImplementation(AuthorizationImplementation authorizationImplementation)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scada.core.server.Service

closeSession, createSession

Methods inherited from interface org.eclipse.scada.utils.lifecycle.LifecycleAware

start, stop

Field Detail

DEFAULT_RESULT

protected static final AuthorizationResult DEFAULT_RESULT

Constructor Detail

ServiceCommon

public ServiceCommon()

Method Detail

setAuditLogService

public void setAuditLogService(AuditLogService auditLogService)

setAuthenticationImplementation

protected void setAuthenticationImplementation(AuthenticationImplementation authenticationImplementation)

setAuthorizationImplementation

protected void setAuthorizationImplementation(AuthorizationImplementation authorizationImplementation)

extractPrivileges

protected Set<String> extractPrivileges(Properties properties)

loginUser

protected NotifyFuture<UserInformation> loginUser(Properties properties,
                                      Map<String,Object> contextInformation,
                                      CallbackHandler callbackHandler)

Wraps the call to #authenticate(Properties) so that the correct exceptions are thrown for a #createSession(Properties) call.

Parameters:

properties - the user session properties

contextInformation - additional context information

callbackHandler - the callback handler which handles callbacks

sessionResultProperties - the map will be filled with the resulting session properties

Returns:

the user information returned by #authenticate(Properties)

See Also:

#authenticate(Properties)

fillSessionProperties

protected void fillSessionProperties(UserInformation userInformation,
                         Map<String,String> sessionResultProperties)

authorize

protected NotifyFuture<AuthorizationReply> authorize(AuthorizationRequest request,
                                         CallbackHandler callbackHandler)

authorize

protected NotifyFuture<AuthorizationReply> authorize(AuthorizationRequest request,
                                         CallbackHandler callbackHandler,
                                         AuthorizationResult defaultResult)

Authorize an operation

The default implementation grants everything. Override to change according to your needs.

Parameters:

objectType - the type of the object the operation takes place

objectId - the id of the object the operation takes place

userInformation - the user information

context - the context information

defaultResult - the default result that should be returned if no one votes, must not be null

Returns:

the authorization result, never returns null

makeEffectiveUserInformation

protected NotifyFuture<UserInformation> makeEffectiveUserInformation(AbstractSessionImpl session,
                                                         String targetUser,
                                                         CallbackHandler handler)