*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.events.broker
Class SecurityContext

com.sas.services.events.broker.SecurityContext

All Implemented Interfaces:

com.sas.PublicClonable, java.io.Serializable, java.lang.Cloneable

public class SecurityContext
implements com.sas.PublicClonable, java.io.Serializable

Security context associated with a particular Event Broker service message.

Usage

A processing node or dynamic listener can aquire this information from the message it is processing.

Since:

1.0

See Also:

Serialized Form

Field Summary

static int	RUN_AS_IDENTITY_BROKER Run as identity: broker
static int	RUN_AS_IDENTITY_CLIENT Run as identity: client
static int	RUN_AS_IDENTITY_NONE Run as identity: none
static int	RUN_AS_IDENTITY_SPECIFIED Run as identity: specified

Constructor Summary

SecurityContext()
Default constructor.

SecurityContext(java.lang.String userName, java.lang.String userPW, java.lang.String domain)
SecurityContext constructor.

Method Summary

java.lang.Object	clone() Clone a copy of this security context.
java.lang.String	getDomain() Get authentication domain.
int	getRunAsIdentity() Get RunAs identity context.
SessionContextInterface	getSessionContext() Get session context.
java.lang.Object	getSessionContextLock() Get session context lock object.
UserContextInterface	getUserContext() Get user context.
java.lang.String	getUserName() Get user name.
java.lang.String	getUserPW() Get user password.
void	setDomain(java.lang.String domain) Set authentication domain.
void	setRunAsIdentity(int runAsIdentity) Set RunAs identity context.
void	setSessionContext(SessionContextInterface sc) Set session context.
void	setSessionContextLock(java.lang.Object lock) Set session context lock object.
void	setUserContext(UserContextInterface uc) Set user context.
void	setUserName(java.lang.String userName) Set user name.
void	setUserPW(java.lang.String userPW) Set user password.

Field Detail

RUN_AS_IDENTITY_NONE

public static final int RUN_AS_IDENTITY_NONE

Run as identity: none

See Also:

Constant Field Values

RUN_AS_IDENTITY_CLIENT

public static final int RUN_AS_IDENTITY_CLIENT

Run as identity: client

See Also:

Constant Field Values

RUN_AS_IDENTITY_BROKER

public static final int RUN_AS_IDENTITY_BROKER

Run as identity: broker

See Also:

Constant Field Values

RUN_AS_IDENTITY_SPECIFIED

public static final int RUN_AS_IDENTITY_SPECIFIED

Run as identity: specified

See Also:

Constant Field Values

Constructor Detail

SecurityContext

public SecurityContext()

Default constructor.

SecurityContext

public SecurityContext(java.lang.String userName,
                       java.lang.String userPW,
                       java.lang.String domain)

SecurityContext constructor.

Parameters:

userName - user name.

userPW - password of user.

domain - security domain

Method Detail

clone

public final java.lang.Object clone()

Clone a copy of this security context.

Perform a shallow copy only.

The session context attribute must be the same object for all instances of a cloned security context so that tracking session management usage works appropriately.

Specified by:

clone in interface com.sas.PublicClonable

Overrides:

clone in class java.lang.Object

Returns:

clone of this message.

setUserName

public final void setUserName(java.lang.String userName)

Set user name.

Parameters:

userName - user name.

getUserName

public final java.lang.String getUserName()

Get user name.

Returns:

user name.

setUserPW

public final void setUserPW(java.lang.String userPW)

Set user password.

Parameters:

userPW - user password.

getUserPW

public final java.lang.String getUserPW()

Get user password.

Returns:

user password.

setDomain

public final void setDomain(java.lang.String domain)

Set authentication domain.

Parameters:

domain - authentication domain.

getDomain

public final java.lang.String getDomain()

Get authentication domain.

Returns:

authentication domain.

setSessionContext

public final void setSessionContext(SessionContextInterface sc)

Set session context.

Parameters:

sc - session context.

getSessionContext

public final SessionContextInterface getSessionContext()

Get session context.

Returns:

session context or null if not available.

setSessionContextLock

public final void setSessionContextLock(java.lang.Object lock)

Set session context lock object.

Parameters:

lock - session context lock object.

getSessionContextLock

public final java.lang.Object getSessionContextLock()

Get session context lock object.

Returns:

session context lock object or null if not available.

setUserContext

public final void setUserContext(UserContextInterface uc)

Set user context.

Parameters:

uc - user context.

getUserContext

public final UserContextInterface getUserContext()

Get user context.

Returns:

user context or null if Run As context was not authenticated.

setRunAsIdentity

public final void setRunAsIdentity(int runAsIdentity)

Set RunAs identity context.

Parameters:

runAsIdentity - RunAs identity context.

getRunAsIdentity

public final int getRunAsIdentity()

Get RunAs identity context.

Valid RunAs identity types are as follows:

• none
• client
• broker
• specified

Returns:

RunAs identity context.

*** This class provides Binary Compatibility only, not Source Compatibility ***