IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.clientserver
Interface SecurityContextInterface

All Superinterfaces:
java.io.Externalizable, java.io.Serializable

public interface SecurityContextInterface
extends java.io.Externalizable

This interface is used by the toolkit to store user info including user id, user roles and session id


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String INI_CONTEXT
           
static int INI_ERROR
           
static java.lang.String SECURITY_CTX
           
static java.lang.String SET_USER_INFO
           
static int SET_USER_INFO_FAILED
           
 
Method Summary
 java.lang.String getSessionId()
          Returns the session id
 java.lang.String getUserId()
          Returns the user id
 Vector getUserRoles()
          Returns the user roles
 boolean isUserInRole(java.lang.String role)
          Returns true if the user is in the given role
 void setUserInfo(java.lang.Object userInfo)
          Sets the user info, including user id, user roles and session id.
 
Methods inherited from interface java.io.Externalizable
readExternal, writeExternal
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

INI_ERROR

static final int INI_ERROR
See Also:
Constant Field Values

SET_USER_INFO_FAILED

static final int SET_USER_INFO_FAILED
See Also:
Constant Field Values

INI_CONTEXT

static final java.lang.String INI_CONTEXT
See Also:
Constant Field Values

SET_USER_INFO

static final java.lang.String SET_USER_INFO
See Also:
Constant Field Values

SECURITY_CTX

static final java.lang.String SECURITY_CTX
See Also:
Constant Field Values
Method Detail

getSessionId

java.lang.String getSessionId()
Returns the session id

Returns:
String The session id

getUserId

java.lang.String getUserId()
Returns the user id

Returns:
String The user id

getUserRoles

Vector getUserRoles()
Returns the user roles

Returns:
com.ibm.btt.base.Vector The user roles

isUserInRole

boolean isUserInRole(java.lang.String role)
Returns true if the user is in the given role

Parameters:
role - java.lang.String
Returns:
boolean

setUserInfo

void setUserInfo(java.lang.Object userInfo)
                 throws ACLException
Sets the user info, including user id, user roles and session id.

Parameters:
userInfo - The object containing user info
Throws:
ACLException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011