com.adobe.edc.server.spi.authorization
Class ExternalAuthResultDTO

java.lang.Object
  extended by com.adobe.edc.server.spi.authorization.ExternalAuthResultDTO
All Implemented Interfaces:
java.io.Serializable

public class ExternalAuthResultDTO
extends java.lang.Object
implements java.io.Serializable

The ExternalAuthResultDTO class is used by the ExternalAuthorizer interface to return the result as part of the evaluate() method.

See Also:
Serialized Form

Constructor Summary
ExternalAuthResultDTO()
           
 
Method Summary
 java.lang.String getAccessDeniedErrorMessage()
          Retrieves the access denied error message set by the external authorizer implementation.
 java.lang.Long getExiprationDate()
          Retrieves the expiration time set by the external authorizer implementation.
 java.lang.Long getOnlineExpirationDate()
          Retrieves the online expiration date set by the external authorizer implementation.
 java.util.ArrayList getPermissions()
          Retrieves the permissions set by the external authorizer implementation.
 void setAccessDeniedErrorMessage(java.lang.String accessDeniedErrorMessage)
          Sets the access denied error message.
 void setExiprationDate(java.lang.Long exiprationDate)
          Sets the expiration date.
 void setOnlineExpirationDate(java.lang.Long onlineExpirationDate)
          Sets the online expiration date.
 void setPermissions(java.util.ArrayList permissions)
          Sets a list of allowable permissions.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExternalAuthResultDTO

public ExternalAuthResultDTO()
Method Detail

getAccessDeniedErrorMessage

public java.lang.String getAccessDeniedErrorMessage()
Retrieves the access denied error message set by the external authorizer implementation.

Returns:
The access denied error message.

setAccessDeniedErrorMessage

public void setAccessDeniedErrorMessage(java.lang.String accessDeniedErrorMessage)
Sets the access denied error message. External authorizer implementation sets this value during the evaluate() method.

Parameters:
accessDeniedErrorMessage - The access denied error message to set.

getOnlineExpirationDate

public java.lang.Long getOnlineExpirationDate()
Retrieves the online expiration date set by the external authorizer implementation.

Returns:
The online expiration date.

setOnlineExpirationDate

public void setOnlineExpirationDate(java.lang.Long onlineExpirationDate)
Sets the online expiration date. External authorizer implementation sets this value during the evaluate() method.

Parameters:
onlineExiprationDate - The value of the online expiration date. The date should be represented as seconds elapsed since epoch time.

getExiprationDate

public java.lang.Long getExiprationDate()
Retrieves the expiration time set by the external authorizer implementation.

Returns:
The expiration time.

setExiprationDate

public void setExiprationDate(java.lang.Long exiprationDate)
Sets the expiration date. External authorizer implementation sets this value during the evaluate() method.

Parameters:
exiprationDate - The value of the expiration date.

getPermissions

public java.util.ArrayList getPermissions()
Retrieves the permissions set by the external authorizer implementation.

Returns:
An java.util.ArrayList of allowable permissions.

setPermissions

public void setPermissions(java.util.ArrayList permissions)
Sets a list of allowable permissions.

Parameters:
permissions - An java.util.ArrayList of permissions.