|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface XConnectModule.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 |
---|
XLoginMechanismInfo getLoginMechanism(String emailAddress)
emailAddress
- The User's login name (email address)XLoginInfo getLoginInfo()
XLoginInfo login(XLoginCredentialsInfo credentials)
credentials
- The Credentials.String getLoginTicket()
void setUser(XObjectID temporaryUserID)
temporaryUserID
- The temporary User for the current request. A null value may be specified to remove any temporary override.void setOnBehalfOfUser(String onBehalfOfUserName)
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.
onBehalfOfUserName
- The User to act on behalf of. May be null.void ping()
void logout()
|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |