Package org.forgerock.openam.uma

Class PermissionTicket

java.lang.Object

org.forgerock.openam.uma.PermissionTicket

All Implemented Interfaces:

org.forgerock.openam.uma.UmaToken

@SupportedAll
public class PermissionTicket
extends Object
implements org.forgerock.openam.uma.UmaToken

A POJO to represent the UMA Permission Ticket. See the UMA Spec for details.

Constructor Summary

Constructors

Constructor	Description
PermissionTicket()
PermissionTicket(String id, JsonValue permissions, String resourceServerClientId, String authGrantId, Boolean issued)

Method Summary

Modifier and Type	Method	Description
String	getClientClientId()
JsonValue	getContents()
Long	getExpiryTime()
String	getGrantId()
String	getId()
Boolean	getIssued()
int	getIteration()	Get the usage iteration of the ticket.
JsonValue	getPermissions()
String	getRealm()
String	getResourceServerClientId()
void	incrementIteration()	Increment the usage iteration of the ticket.
void	setClientClientId(String clientClientId)
void	setContents(JsonValue contents)
void	setExpiryTime(Long expiryTime)
void	setGrantId(String authGrantId)
void	setId(String id)
void	setIssued(Boolean issued)
void	setRealm(String realm)
void	setResourceServerClientId(String resourceServerClientId)

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionTicket

public PermissionTicket(String id,
                        JsonValue permissions,
                        String resourceServerClientId,
                        String authGrantId,
                        Boolean issued)

PermissionTicket

public PermissionTicket()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getRealm

public String getRealm()

setRealm

public void setRealm(String realm)

getExpiryTime

public Long getExpiryTime()

setExpiryTime

public void setExpiryTime(Long expiryTime)

getResourceServerClientId

public String getResourceServerClientId()

setResourceServerClientId

public void setResourceServerClientId(String resourceServerClientId)

getClientClientId

public String getClientClientId()

setClientClientId

public void setClientClientId(String clientClientId)

incrementIteration

public void incrementIteration()

Increment the usage iteration of the ticket.

getIteration

public int getIteration()

Get the usage iteration of the ticket.

Returns:

The usage iteration count.

getContents

public JsonValue getContents()

setContents

public void setContents(JsonValue contents)

getGrantId

public String getGrantId()

setGrantId

public void setGrantId(String authGrantId)

getIssued

public Boolean getIssued()

setIssued

public void setIssued(Boolean issued)

getPermissions

public JsonValue getPermissions()