com.novell.emframe.dev

Class ManagementServiceSet

java.lang.Object

com.novell.emframe.dev.ManagementServiceSet

public class ManagementServiceSet
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.novell.emframe.fw.authenticator.DirAuthenticator	m_dirAuth
protected javax.servlet.http.HttpSession	m_session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ManagementServiceSet(com.novell.emframe.fw.authenticator.DirAuthenticator dirAuth) Constructs an empty ManagementServiceSet.

Method Summary

Modifier and Type	Method and Description
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.
java.util.LinkedHashMap	getAuthenticationBrokers() Returns the authBrokers
DirUtils	getDirUtils() Returns the DirUtils object associated with this logged in user.
java.lang.String	getGlobalVar(java.lang.String varName) Deprecated. use getAttribute
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() Deprecated. as of 2.6 not needed.
java.util.Hashtable	getSessionCache() Deprecated. The newer getAttribute(), setAttribute, and removeAttribute() calls should be used.
java.lang.String	handleDirectoryEvent(com.novell.admin.event.DirectoryEvent event, java.lang.Object userData) Handles a directory event notification
boolean	isAuthenticated(javax.servlet.http.HttpServletRequest req) Returns whether authentication has successfully occurred.
boolean	isDisconnected() This call will return true or false if in disconnected mode.
boolean	isPrimaryDataStore() This call will return true or false if this is a PRIMARY service set.
boolean	login(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Login using information available in the HttpServletRequest.
void	removeAttribute(java.lang.Object attrKey) Removes the attribute key and associated value if present.
void	removeGlobalVar(java.lang.String varName) Deprecated. use removeAttribute
void	resetPIdentity(java.lang.String new_PIdentity) Resets the password if it is changed after initial login/creation.
void	setAttribute(java.lang.Object attrKey, java.lang.Object attrValue) Saves the specified attribute value with the specified attribute key.
void	setDisconnected(boolean isDisconnected) Set the management service set into the disconnected mode or not disconnected.
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

Field Detail

m_dirAuth

protected com.novell.emframe.fw.authenticator.DirAuthenticator m_dirAuth

m_session

protected javax.servlet.http.HttpSession m_session

Constructor Detail

ManagementServiceSet

protected ManagementServiceSet(com.novell.emframe.fw.authenticator.DirAuthenticator dirAuth)

Constructs an empty ManagementServiceSet.

Parameters:

dirAuth -

Method Detail

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)

isAuthenticated

public boolean isAuthenticated(javax.servlet.http.HttpServletRequest req)

Returns whether authentication has successfully occurred.

Parameters:

req -

Returns:

boolean: true if authentication has successfully occurred, false if otherwise

login

public boolean login(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)

Login using information available in the HttpServletRequest.

Parameters:

req - The HttpServletRequest object

res - The HttpServletResponse object

Returns:

boolean: true if login was successful, false if otherwise

getLocale

public java.util.Locale getLocale()

Returns the user's locale.

Returns:

Locale object containing the current user's locale

getSession

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

Deprecated. as of 2.6 not needed.

Returns the user's PortalSession.

Returns:

PortalSession for the current user

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.

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)

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.

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)

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)

getDirUtils

public DirUtils getDirUtils()

Returns the DirUtils object associated with this logged in user.

Returns:

DirUtils utility methods for accessing the directory

getAuthenticationBroker

public AuthenticationBroker getAuthenticationBroker()

Returns the AuthenticationBroker associated with this logged in user.

Returns:

AuthenticationBroker associated with this ManagementServiceSet

getAuthenticationBrokers

public java.util.LinkedHashMap getAuthenticationBrokers()

Returns the authBrokers

Returns:

Hashtable

resetPIdentity

public void resetPIdentity(java.lang.String new_PIdentity)
                    throws AuthBrokerException

Resets the password if it is changed after initial login/creation. If the AuthenticationBroker has been created it is pushed on into it, else it is just within put into this management service set.

Parameters:

new_PIdentity - String containing the new password

Throws:

AuthBrokerException - if there is a problem resetting the password

isPrimaryDataStore

public boolean isPrimaryDataStore()

This call will return true or false if this is a PRIMARY service set.

Returns:

boolean: true is PRIMARY, false if otherwise

setDisconnected

public void setDisconnected(boolean isDisconnected)

Set the management service set into the disconnected mode or not disconnected. As of right now, disconnected means that you are running in the LDAP data store and logged into that data store as the primary user.

Parameters:

isDisconnected - true if disconnected, false if not

isDisconnected

public boolean isDisconnected()

This call will return true or false if in disconnected mode. As of right now, disconnected means that you are running in the LDAP data store and logged into that data store as the primary user.

Returns:

boolean: true if disconnected, false if not

getGlobalVar

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

Deprecated. use getAttribute

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)

setGlobalVar

public final 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)

removeGlobalVar

public final void removeGlobalVar(java.lang.String varName)

Deprecated. use removeAttribute

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)

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

handleDirectoryEvent

public java.lang.String handleDirectoryEvent(com.novell.admin.event.DirectoryEvent event,
                                             java.lang.Object userData)

Handles a directory event notification

Parameters:

event - - The directory event to handle. This event should be created by the directory interface implementation.

userData -

Returns:

String