wt.session
Interface SessionManager

All Known Implementing Classes:

StandardSessionManager

public interface SessionManager

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

Supported API: true

Extendable: false

Method Summary

WTPrincipal	getAdministrator() Returns the default administrator.
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.

Method Detail

getPrincipal

WTPrincipal getPrincipal()
                         throws WTException

Retrieves current principal.

Supported API: true

Returns:

WTPrincipal

Throws:

WTException

getPrincipalReference

WTPrincipalReference getPrincipalReference()
                                           throws WTException

Retrieves a reference to the current principal.

Supported API: true

Returns:

WTPrincipalReference

Throws:

WTException

setPrincipal

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: true

Parameters:

name -

Returns:

WTPrincipal

Throws:

WTException

setAdministrator

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: true

Returns:

WTPrincipal

Throws:

WTException

getAdministrator

WTPrincipal getAdministrator()
                             throws WTException

Returns the default administrator.

Supported API: true

Returns:

WTPrincipal

Throws:

WTException

setAuthenticatedPrincipal

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: true

Parameters:

web_name -

Throws:

WTException