org.alfresco.webservice.util

Class AuthenticationDetails

java.lang.Object

org.alfresco.webservice.util.AuthenticationDetails

public class AuthenticationDetails
extends Object

Helper class to contain web service authentication credentials

Author:

Roy Wetherall

Constructor Summary

Constructors

Constructor and Description
AuthenticationDetails(String userName, String ticket, String sessionId) Constructor with deafault timeoutInterval = -1 (Tiket is never expired)
AuthenticationDetails(String userName, String ticket, String sessionId, long timeoutInterval) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getSessionId() Gets the session id
String	getTicket() Gets the ticket
long	getTimeoutInterval()
String	getUserName() Gets the user name
boolean	isTimedOut()
void	resetTimeoutInterval()
void	setTimeoutInterval(long timeoutInterval)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationDetails

public AuthenticationDetails(String userName,
                     String ticket,
                     String sessionId)

Constructor with deafault timeoutInterval = -1 (Tiket is never expired)

Parameters:

userName - the user name

ticket - the ticket

sessionId - the session id

AuthenticationDetails

public AuthenticationDetails(String userName,
                     String ticket,
                     String sessionId,
                     long timeoutInterval)

Constructor

Parameters:

userName - the user name

ticket - the ticket

sessionId - the session id

timeoutInterval - timeout interval

Method Detail

getUserName

public String getUserName()

Gets the user name

Returns:

the user name

getTicket

public String getTicket()

Gets the ticket

Returns:

the ticket

getSessionId

public String getSessionId()

Gets the session id

Returns:

the sessio id, may return null if no session id is set

getTimeoutInterval

public long getTimeoutInterval()

setTimeoutInterval

public void setTimeoutInterval(long timeoutInterval)

isTimedOut

public final boolean isTimedOut()

Returns:

if timeoutInterval is not set return false. If current time > (wsLastTimeUsed.getTime() + timeoutInterval) return true

resetTimeoutInterval

public void resetTimeoutInterval()