com.novell.emframe.dev
Class ManagementServiceSet

java.lang.Object
  com.novell.emframe.dev.ManagementServiceSet

All Implemented Interfaces:

com.novell.nps.authentication.AuthenticationEventListener, iMgrAuthenticator

public class ManagementServiceSet

extends java.lang.Object

implements com.novell.nps.authentication.AuthenticationEventListener, iMgrAuthenticator

Defines a set of services that are used within the iManager framework.

Field Summary

static java.lang.String	DEFAULT_DEFAULT_PROTOCOL DEFAULT_DEFAULT_PROTOCOL = VALUE_DEFAULT_PROTOCOL_NDAP.
static java.lang.String	DEFAULT_ENABLE_CONTEXTLESS_LOGIN DEFAULT_ENABLE_CONTEXTLESS_LOGIN = "true".
static int	DEFAULT_HASHTABLE_CAPACITY DEFAULT_HASHTABLE_CAPACITY = 60.
static java.lang.String	DEFAULT_SHOW_PROTOCOL DEFAULT_SHOW_PROTOCOL = "true".
static java.lang.String	DEFAULT_SHOW_TREE DEFAULT_SHOW_TREE = "true".
static java.lang.String	DEFAULT_USE_COOKIES DEFAULT_USE_COOKIES = "false".
protected AuthContext	m_authContext AuthContext object.
protected boolean	m_bLoggedIn Whether this ManagementServiceSet is currently logged in.
protected com.novell.emframe.fw.authenticator.Profile	m_defProfile Default profile.
protected int	m_mssType Type of the ManagementServiceSet.
protected java.util.HashMap	m_profileMap HashMap of profiles using the settings in the AuthClassContext.
protected javax.servlet.http.HttpSession	m_session Current HttpSession.
static java.lang.String	SETTING_DEFAULT_PROTOCOL SETTING_DEFAULT_PROTOCOL = "Authenticate.Form.DefaultProtocol".
static java.lang.String	SETTING_DEFAULT_TREE SETTING_DEFAULT_TREE = "Authenticate.Form.DefaultTree".
static java.lang.String	SETTING_ENABLE_CONTEXTLESS_LOGIN SETTING_ENABLE_CONTEXTLESS_LOGIN = "Authenticate.Form.EnableContextlessLogin".
static java.lang.String	SETTING_PUBLIC_PASSWORD SETTING_PUBLIC_PASSWORD = "Authenticate.Form.PublicPassword.".
static java.lang.String	SETTING_PUBLIC_USER SETTING_PUBLIC_USER = "Authenticate.Form.PublicUser.".
static java.lang.String	SETTING_SEARCH_CONTAINERS SETTING_SEARCH_CONTAINERS = "Authenticate.Form.SearchContainers.".
static java.lang.String	SETTING_SHOW_PROTOCOL SETTING_SHOW_PROTOCOL = "Authenticate.Form.ShowProtocol".
static java.lang.String	SETTING_SHOW_TREE SETTING_SHOW_TREE = "Authenticate.Form.ShowTree".
static java.lang.String	SETTING_USE_COOKIES SETTING_USE_COOKIES = "Authenticate.Form.UseCookies".
static java.lang.String	VALUE_DEFAULT_PROTOCOL_LDAP VALUE_DEFAULT_PROTOCOL_LDAP = "LDAP".
static java.lang.String	VALUE_DEFAULT_PROTOCOL_LDAPS VALUE_DEFAULT_PROTOCOL_LDAPS = "LDAPS".
static java.lang.String	VALUE_DEFAULT_PROTOCOL_NDAP VALUE_DEFAULT_PROTOCOL_NDAP = "NDAP".

Fields inherited from interface com.novell.emframe.dev.authenticator.iMgrAuthenticator

IMGR_AUTH_HASHMAP, IMGR_AUTH_KEYROOT

Method Summary

java.lang.Object	getAttribute(java.lang.Object attrKey) Returns the value to which the specified attribute key is associated with.
AuthenticationBroker	getAuthenticationBroker() Returns the AuthenticationBroker associated with this logged in user.
DirUtils	getDirUtils() Returns the DirUtils object associated with this logged in user.
java.lang.String	getGlobalVar(java.lang.String varName) Returns the value to which the specified attribute key is associated with.
java.util.Locale	getLocale() Returns the user's locale.
static ManagementServiceSet	getManagementServiceSet(javax.servlet.http.HttpSession session) Static method to get the correct ManagementServiceSet based the current HttpSession.
com.novell.nps.sessionManager.PortalSession	getSession() Returns the user's PortalSession.
java.util.Hashtable	getSessionCache() Deprecated. The newer getAttribute(), setAttribute, and removeAttribute() calls should be used.
void	removeAttribute(java.lang.Object attrKey) Removes the attribute key and associated value if present.
void	removeGlobalVar(java.lang.String varName) Removes the attribute key and associated value if present.
void	setAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Saves the specified attribute value with the specified attribute key.
void	setGlobalVar(java.lang.String varName, java.lang.String val) Saves the specified attribute value with the specified attribute key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.novell.nps.authentication.AuthenticationEventListener

loginEvent, postLogoutEvent, preLogoutEvent

Methods inherited from interface com.novell.emframe.dev.authenticator.iMgrAuthenticator

destroy, getAuthContext, init, isAuthenticated, login, login, logout

Field Detail

DEFAULT_DEFAULT_PROTOCOL

public static final java.lang.String DEFAULT_DEFAULT_PROTOCOL

DEFAULT_DEFAULT_PROTOCOL = VALUE_DEFAULT_PROTOCOL_NDAP.

See Also:

Constant Field Values

DEFAULT_ENABLE_CONTEXTLESS_LOGIN

public static final java.lang.String DEFAULT_ENABLE_CONTEXTLESS_LOGIN

DEFAULT_ENABLE_CONTEXTLESS_LOGIN = "true".

See Also:

Constant Field Values

DEFAULT_HASHTABLE_CAPACITY

public static final int DEFAULT_HASHTABLE_CAPACITY

DEFAULT_HASHTABLE_CAPACITY = 60.

See Also:

Constant Field Values

DEFAULT_SHOW_PROTOCOL

public static final java.lang.String DEFAULT_SHOW_PROTOCOL

DEFAULT_SHOW_PROTOCOL = "true".

See Also:

Constant Field Values

DEFAULT_SHOW_TREE

public static final java.lang.String DEFAULT_SHOW_TREE

DEFAULT_SHOW_TREE = "true".

See Also:

Constant Field Values

DEFAULT_USE_COOKIES

public static final java.lang.String DEFAULT_USE_COOKIES

DEFAULT_USE_COOKIES = "false".

See Also:

Constant Field Values

m_authContext

protected AuthContext m_authContext

AuthContext object.

m_bLoggedIn

protected boolean m_bLoggedIn

Whether this ManagementServiceSet is currently logged in.

m_defProfile

protected com.novell.emframe.fw.authenticator.Profile m_defProfile

Default profile.

m_mssType

protected int m_mssType

Type of the ManagementServiceSet.

m_profileMap

protected java.util.HashMap m_profileMap

HashMap of profiles using the settings in the AuthClassContext.

m_session

protected javax.servlet.http.HttpSession m_session

Current HttpSession.

SETTING_DEFAULT_PROTOCOL

public static final java.lang.String SETTING_DEFAULT_PROTOCOL

SETTING_DEFAULT_PROTOCOL = "Authenticate.Form.DefaultProtocol".

See Also:

Constant Field Values

SETTING_DEFAULT_TREE

public static final java.lang.String SETTING_DEFAULT_TREE

SETTING_DEFAULT_TREE = "Authenticate.Form.DefaultTree".

See Also:

Constant Field Values

SETTING_ENABLE_CONTEXTLESS_LOGIN

public static final java.lang.String SETTING_ENABLE_CONTEXTLESS_LOGIN

SETTING_ENABLE_CONTEXTLESS_LOGIN = "Authenticate.Form.EnableContextlessLogin".

See Also:

Constant Field Values

SETTING_PUBLIC_PASSWORD

public static final java.lang.String SETTING_PUBLIC_PASSWORD

SETTING_PUBLIC_PASSWORD = "Authenticate.Form.PublicPassword.".

See Also:

Constant Field Values

SETTING_PUBLIC_USER

public static final java.lang.String SETTING_PUBLIC_USER

SETTING_PUBLIC_USER = "Authenticate.Form.PublicUser.".

See Also:

Constant Field Values

SETTING_SEARCH_CONTAINERS

public static final java.lang.String SETTING_SEARCH_CONTAINERS

SETTING_SEARCH_CONTAINERS = "Authenticate.Form.SearchContainers.".

See Also:

Constant Field Values

SETTING_SHOW_PROTOCOL

public static final java.lang.String SETTING_SHOW_PROTOCOL

SETTING_SHOW_PROTOCOL = "Authenticate.Form.ShowProtocol".

See Also:

Constant Field Values

SETTING_SHOW_TREE

public static final java.lang.String SETTING_SHOW_TREE

SETTING_SHOW_TREE = "Authenticate.Form.ShowTree".

See Also:

Constant Field Values

SETTING_USE_COOKIES

public static final java.lang.String SETTING_USE_COOKIES

SETTING_USE_COOKIES = "Authenticate.Form.UseCookies".

See Also:

Constant Field Values

VALUE_DEFAULT_PROTOCOL_LDAP

public static final java.lang.String VALUE_DEFAULT_PROTOCOL_LDAP

VALUE_DEFAULT_PROTOCOL_LDAP = "LDAP".

See Also:

Constant Field Values

VALUE_DEFAULT_PROTOCOL_LDAPS

public static final java.lang.String VALUE_DEFAULT_PROTOCOL_LDAPS

VALUE_DEFAULT_PROTOCOL_LDAPS = "LDAPS".

See Also:

Constant Field Values

VALUE_DEFAULT_PROTOCOL_NDAP

public static final java.lang.String VALUE_DEFAULT_PROTOCOL_NDAP

VALUE_DEFAULT_PROTOCOL_NDAP = "NDAP".

See Also:

Constant Field Values

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.Object attrKey)

Returns the value to which the specified attribute key is associated with. If no associated key is found, then null will be returned. Attribute keys should be prefixed with the module id to avoid collisions. This is the same as getGlobalVar, except this call takes any Object instead of just Strings.

Specified by:

getAttribute in interface iMgrAuthenticator

Parameters:

attrKey - Object containing the attribute key whose associated value is to be returned This may not be null.

Returns:

Object value associated with key or null if no attribute key was found

See Also:

setAttribute(java.lang.Object, java.lang.Object), getGlobalVar(java.lang.String)

getAuthenticationBroker

public AuthenticationBroker getAuthenticationBroker()

Returns the AuthenticationBroker associated with this logged in user.

Returns:

AuthenticationBroker associated with this ManagementServiceSet

getDirUtils

public DirUtils getDirUtils()

Returns the DirUtils object associated with this logged in user.

Returns:

DirUtils utility methods for accessing the directory

getGlobalVar

public java.lang.String getGlobalVar(java.lang.String varName)

Returns the value to which the specified attribute key is associated with. If no associated key is found, then null will be returned. Attribute keys should be prefixed with the module id to avoid collisions. This call is the same as getAttribute but this call only accepts Strings.

Parameters:

varName - String containing the attribute key whose associated value is to be returned This may not be null.

Returns:

String value associated with key or null if no attribute key was found

See Also:

setGlobalVar(java.lang.String, java.lang.String), getAttribute(java.lang.Object)

getLocale

public java.util.Locale getLocale()

Returns the user's locale.

Returns:

Locale object containing the current user's locale

getManagementServiceSet

public static ManagementServiceSet getManagementServiceSet(javax.servlet.http.HttpSession session)

Static method to get the correct ManagementServiceSet based the current HttpSession. If the requested ManagementServiceSet is not available a null is returned.

Parameters:

session - The current HttpSession

Returns:

ManagementServiceSet used by the session or null

getSession

public com.novell.nps.sessionManager.PortalSession getSession()

Returns the user's PortalSession.

Returns:

PortalSession for the current user

getSessionCache

public java.util.Hashtable getSessionCache()

Deprecated. The newer getAttribute(), setAttribute, and removeAttribute() calls should be used.

Returns the internal Hashtable that used to store and retrieve attributes.

Returns:

Hashtable that used to store and retrieve attributes

See Also:

getAttribute(java.lang.Object), setAttribute(java.lang.Object, java.lang.Object), removeAttribute(java.lang.Object)

removeAttribute

public void removeAttribute(java.lang.Object attrKey)

Removes the attribute key and associated value if present. Attribute keys should be prefixed with the module id to avoid collisions. This is the same as removeGlobalVar, except this call takes any Object instead of just Strings.

Parameters:

attrKey - Object containing the attribute key whose associated value is to be removed This may not be null.

See Also:

removeGlobalVar(java.lang.String)

removeGlobalVar

public void removeGlobalVar(java.lang.String varName)

Removes the attribute key and associated value if present. Attribute keys should be prefixed with the module id to avoid collisions. This is the same as removeAttribute, except this call only accepts Strings.

Parameters:

varName - String containing the attribute key whose associated value is to be removed This may not be null.

See Also:

removeAttribute(java.lang.Object)

setAttribute

public void setAttribute(java.lang.Object attrKey,
                         java.lang.Object attrValue)

Saves the specified attribute value with the specified attribute key. If a previous value for this attribute key existed, it will be overwritten. Attribute keys should be prefixed with the module id to avoid collisions. This is the same as setGlobalVar, except this call takes any Object instead of just Strings.

Specified by:

setAttribute in interface iMgrAuthenticator

Parameters:

attrKey - Object containing the attribute key whose associated value is to be set This may not be null.

attrValue - Object value to be saved. This may not be null.

See Also:

getAttribute(java.lang.Object), setGlobalVar(java.lang.String, java.lang.String)

setGlobalVar

public void setGlobalVar(java.lang.String varName,
                         java.lang.String val)

Saves the specified attribute value with the specified attribute key. If a previous value for this attribute key existed, it will be overwritten. Attribute keys should be prefixed with the module id to avoid collisions. This is the same as setAttribute, except this call only accepts Strings.

Parameters:

varName - String containing the attribute key whose associated value is to be set This may not be null.

val - String value to be saved. This may not be null.

See Also:

getGlobalVar(java.lang.String), setAttribute(java.lang.Object, java.lang.Object)