com.contentful.java.cma.model

Class CMAPersonalAccessToken

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMAPersonalAccessToken

public class CMAPersonalAccessToken
extends CMAResource

Model storing the information about a personal access token.

Once a personal access token is created, it's token field will be returned only once: directly as a result of the create call.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CMAPersonalAccessToken.Scope Enum holding the allowed values of scope.

Constructor Summary

Constructors

Constructor and Description
CMAPersonalAccessToken() Create a new personal access token to be uploaded to Contentful.

Method Summary

Modifier and Type	Method and Description
CMAPersonalAccessToken	addScope(CMAPersonalAccessToken.Scope scope) Add a new scope to the list of scopes.
java.lang.String	getName()
java.lang.String	getRevokedAt()
java.util.List<CMAPersonalAccessToken.Scope>	getScopes()
java.lang.String	getToken() This getter returns the token string of this token.
CMAPersonalAccessToken	setName(java.lang.String name) Sets the name for this personal access token.
CMAPersonalAccessToken	setSystem(CMASystem system) Sets the system field.
java.lang.String	toString()

Methods inherited from class com.contentful.java.cma.model.CMAResource

getEnvironmentId, getId, getSpaceId, getSystem, getVersion, isArchived, isPublished, setEnvironmentId, setId, setSpaceId, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAPersonalAccessToken

public CMAPersonalAccessToken()

Create a new personal access token to be uploaded to Contentful.

Method Detail

setSystem

public CMAPersonalAccessToken setSystem(CMASystem system)

Sets the system field.

Overrides:

setSystem in class CMAResource

Parameters:

system - sets the system property.

Returns:

this, as casted to a resource, for the ease of chaining.

getName

public java.lang.String getName()

Returns:

the name of this personal access token.

setName

public CMAPersonalAccessToken setName(java.lang.String name)

Sets the name for this personal access token.

Parameters:

name - the name of the personal access token to be set.

Returns:

this CMAPersonalAccessToken instance.

getRevokedAt

public java.lang.String getRevokedAt()

Returns:

the time this token was revoked, or null if it is still active.

See Also:

ModulePersonalAccessTokens.revoke(CMAPersonalAccessToken)

addScope

public CMAPersonalAccessToken addScope(CMAPersonalAccessToken.Scope scope)

Add a new scope to the list of scopes. Creates a new list of scopes if no scopes found.

Parameters:

scope - the new scope to be added.

Returns:

this instance for chaining.

getScopes

public java.util.List<CMAPersonalAccessToken.Scope> getScopes()

Returns:

all added scopes or null if no scopes where added.

getToken

public java.lang.String getToken()

This getter returns the token string of this token.

This string is to be used instead of the CMA token used to create it. Sadly it is only available directly after the token got created, as a response to the create call. Subsequent calls of fetching it by id, or as a collection request, will not return it, so please save it securely after creation.

Returns:

the token string if just created or null.

toString

public java.lang.String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.