Skip navigation links

waggle.common.modules.connect
Interface XConnectModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XConnectModule

public static interface XConnectModule.Server

extends XAPIInterface.Server

Server interface for the Connection Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XLoginInfo	getLoginInfo() Get current login information if logged in.
XLoginMechanismInfo	getLoginMechanism(String emailAddress) Determine how the login should proceed, based on the User's login name (email address).
String	getLoginTicket() Return a login ticket for the current User.
XLoginInfo	login(XLoginCredentialsInfo credentials) Perform a login.
void	logout() Perform logout.
void	ping() Ping the server, method is a no-op, indicates that the client is still active and the session should not be reaped (aka a heartbeat call).
void	setOnBehalfOfUser(String onBehalfOfUserName) Set the current session to be acting on behalf of the specified User.
void	setUser(XObjectID temporaryUserID) Set a temporary User for the current request.

Method Detail

getLoginMechanism

XLoginMechanismInfo getLoginMechanism(String emailAddress)

Determine how the login should proceed, based on the User's login name (email address).

Parameters:

emailAddress - The User's login name (email address)

Returns:

A DTO that describes how login should proceed.

getLoginInfo

XLoginInfo getLoginInfo()

Get current login information if logged in.

Returns:

The current XLoginInfo or null if not logged in.

login

XLoginInfo login(XLoginCredentialsInfo credentials)

Perform a login.

Parameters:

credentials - The Credentials.

Returns:

Login information.

getLoginTicket

String getLoginTicket()

Return a login ticket for the current User. This ticket can be used as a request parameter on HTTP and WebDAV requests as a substitute for the User's authentication credentials. Each login ticket is single-use and is valid for a short amount of time (typically less than a minute).

Returns:

A unique single-User login ticket.

setUser

void setUser(XObjectID temporaryUserID)

Set a temporary User for the current request. Used by extension modules to perform work as other Users.

Parameters:

temporaryUserID - The temporary User for the current request. A null value may be specified to remove any temporary override.

setOnBehalfOfUser

void setOnBehalfOfUser(String onBehalfOfUserName)

Set the current session to be acting on behalf of the specified User.

All access is still controlled by the User that logged in. All actions the User performs while acting on behalf of another User are marked with the User that the session was acting on behalf of at the time. There are no access check related to the User that the current session is acting on behalf of.

Parameters:

onBehalfOfUserName - The User to act on behalf of. May be null.

ping

void ping()

Ping the server, method is a no-op, indicates that the client is still active and the session should not be reaped (aka a heartbeat call).

logout

void logout()

Perform logout.

Skip navigation links