wt.session
Class SessionManagerFwd

java.lang.Object
  wt.session.SessionManagerFwd

All Implemented Interfaces:

RemoteAccess, Serializable, SessionManager

public class SessionManagerFwd

extends Object

implements RemoteAccess, SessionManager, Serializable

Interface containing the methods for setting and retrieving the current principal.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Fields inherited from interface wt.session.SessionManager

ACCEPT_LANGUAGE

Constructor Summary

SessionManagerFwd()

Method Summary

void	destroySessionContext(String prefix, String sessionId) Given prefix and sessionId of a SessionContext created via getContext(prefix,sessionId), find that session and destroy it.
WTPrincipal	getAdministrator() Returns the default administrator.
Vector	getLanguagePreference() Supported API: false
Locale	getLocale() Supported API: false
private static Manager	getManager()
WTPrincipal	getPrincipal() Retrieves current principal.
WTPrincipalReference	getPrincipalReference() Retrieves a reference to the current principal.
WTPrincipal	setAdministrator() Sets the default administrator as the current principal.
void	setAuthenticatedPrincipal(String web_name) Set the current principal given its web server authentication id.
WTPrincipal	setPrincipal(String name) Sets the current principal given the principal's name.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

SessionManagerFwd

public SessionManagerFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

getPrincipal

public WTPrincipal getPrincipal()
                         throws WTException

Retrieves current principal.

Supported API: false

Specified by:

getPrincipal in interface SessionManager

Returns:

WTPrincipal

Throws:

WTException

getPrincipalReference

public WTPrincipalReference getPrincipalReference()
                                           throws WTException

Retrieves a reference to the current principal.

Supported API: false

Specified by:

getPrincipalReference in interface SessionManager

Returns:

WTPrincipalReference

Throws:

WTException

setPrincipal

public WTPrincipal setPrincipal(String name)
                         throws WTException

Sets the current principal given the principal's name. Throws 'UserNotFoundexception' if principal can't be found.

This method is accessible at the client only when the wt.session.clientAuthenticatedLogin is set to false in wt.properties or the current principal is part of the administrators group.

Supported API: false

Specified by:

setPrincipal in interface SessionManager

Parameters:

name -

Returns:

WTPrincipal

Throws:

WTException

setAdministrator

public WTPrincipal setAdministrator()
                             throws WTException

Sets the default administrator as the current principal.

This method is accessible at the client only when the wt.session.clientAuthenticatedLogin is set to false in wt.properties or the current principal is part of the administrators group.

Supported API: false

Specified by:

setAdministrator in interface SessionManager

Returns:

WTPrincipal

Throws:

WTException

getAdministrator

public WTPrincipal getAdministrator()
                             throws WTException

Returns the default administrator.

Supported API: false

Specified by:

getAdministrator in interface SessionManager

Returns:

WTPrincipal

Throws:

WTException

setAuthenticatedPrincipal

public void setAuthenticatedPrincipal(String web_name)
                               throws WTException

Set the current principal given its web server authentication id. Throws 'UserNotFoundException' if principal can't be found.

Supported API: false

Specified by:

setAuthenticatedPrincipal in interface SessionManager

Parameters:

web_name -

Throws:

WTException

getLocale

public Locale getLocale()
                 throws WTException

Supported API: false

Specified by:

getLocale in interface SessionManager

Returns:

Locale

Throws:

WTException

getLanguagePreference

public Vector getLanguagePreference()
                             throws WTException

Supported API: false

Specified by:

getLanguagePreference in interface SessionManager

Returns:

Vector

Throws:

WTException

destroySessionContext

public void destroySessionContext(String prefix,
                                  String sessionId)
                           throws WTException

Given prefix and sessionId of a SessionContext created via getContext(prefix,sessionId), find that session and destroy it.

This is intended for use from the servlet engine to allow the Windchill SessionContext to be destroyed when the servlet session is destroyed to release objects more quickly in some cases.

Supported API: false

Specified by:

destroySessionContext in interface SessionManager

Parameters:

prefix - used guarentee uniqueness to the key

sessionId - session id of the JSP/Servlet engine calling the method server

Throws:

WTException