org.cloudfoundry.uaa.clients

Class Client

java.lang.Object

org.cloudfoundry.uaa.clients.Client

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class Client
extends Object

The resource in the list clients response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Builder Builds instances of type Client.

Method Summary

Modifier and Type	Method and Description
static Client.Builder	builder() Creates a builder for Client.
boolean	equals(Object another) This instance is equal to all instances of Client that have equal attribute values.
Long	getAccessTokenValidity() The access token validity
String	getAction() The action
List<String>	getAllowedProviders() A list of origin keys (alias) for identity providers the client is limited to.
Boolean	getApprovalsDeleted() Were the approvals deleted for the client, and an audit event sent
List<String>	getAuthorities() Scopes that the client is able to grant when creating a client
List<GrantType>	getAuthorizedGrantTypes() List of grant types that can be used to obtain a token with this client.
List<String>	getAutoApproves() Scopes that do not require user approval
String	getClientId() Client identifier, unique within identity zone
String	getCreatedWith() What scope the bearer token had when client was created
Long	getLastModified() Epoch of the moment the client information was last altered
String	getName() A human readable name for the client
List<String>	getRedirectUriPatterns() Allowed URI patterns for redirect during authorization
Long	getRefreshTokenValidity() The refresh token validity
List<String>	getRequiredUserGroups() The required user groups
List<String>	getResourceIds() Resources the client is allowed access to
List<String>	getScopes() Scopes allowed for the client
String	getTokenSalt() A random string used to generate the client’s revocation key.
int	hashCode() Computes a hash code from attributes: accessTokenValidity, action, allowedProviders, approvalsDeleted, authorities, authorizedGrantTypes, autoApproves, clientId, createdWith, lastModified, name, redirectUriPatterns, refreshTokenValidity, requiredUserGroups, resourceIds, scopes, tokenSalt.
String	toString() Prints the immutable value Client with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAccessTokenValidity

public Long getAccessTokenValidity()

The access token validity

getAction

public String getAction()

The action

getAllowedProviders

public List<String> getAllowedProviders()

A list of origin keys (alias) for identity providers the client is limited to. Null implies any identity provider is allowed.

getApprovalsDeleted

public Boolean getApprovalsDeleted()

Were the approvals deleted for the client, and an audit event sent

getAuthorities

public List<String> getAuthorities()

Scopes that the client is able to grant when creating a client

getAuthorizedGrantTypes

public List<GrantType> getAuthorizedGrantTypes()

List of grant types that can be used to obtain a token with this client. Can include authorization_code, password, implicit, and/or client_credentials.

getAutoApproves

public List<String> getAutoApproves()

Scopes that do not require user approval

getClientId

public String getClientId()

Client identifier, unique within identity zone

getCreatedWith

public String getCreatedWith()

What scope the bearer token had when client was created

getLastModified

public Long getLastModified()

Epoch of the moment the client information was last altered

getName

public String getName()

A human readable name for the client

getRedirectUriPatterns

public List<String> getRedirectUriPatterns()

Allowed URI patterns for redirect during authorization

getRefreshTokenValidity

public Long getRefreshTokenValidity()

The refresh token validity

getRequiredUserGroups

public List<String> getRequiredUserGroups()

The required user groups

getResourceIds

public List<String> getResourceIds()

Resources the client is allowed access to

getScopes

public List<String> getScopes()

Scopes allowed for the client

getTokenSalt

public String getTokenSalt()

A random string used to generate the client’s revocation key. Change this value to revoke all active tokens for the client

equals

public boolean equals(Object another)

This instance is equal to all instances of Client that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: accessTokenValidity, action, allowedProviders, approvalsDeleted, authorities, authorizedGrantTypes, autoApproves, clientId, createdWith, lastModified, name, redirectUriPatterns, refreshTokenValidity, requiredUserGroups, resourceIds, scopes, tokenSalt.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Client with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static Client.Builder builder()

Creates a builder for Client.

 Client.builder()
    .accessTokenValidity(Long | null) // nullable accessTokenValidity
    .action(String | null) // nullable action
    .allowedProviders(List<String> | null) // nullable allowedProviders
    .approvalsDeleted(Boolean | null) // nullable approvalsDeleted
    .authority|addAllAuthorities(String) // authorities elements
    .authorizedGrantType|addAllAuthorizedGrantTypes(org.cloudfoundry.uaa.tokens.GrantType) // authorizedGrantTypes elements
    .autoApprove|addAllAutoApproves(String) // autoApproves elements
    .clientId(String) // required clientId
    .createdWith(String | null) // nullable createdWith
    .lastModified(Long | null) // nullable lastModified
    .name(String | null) // nullable name
    .redirectUriPatterns(List<String> | null) // nullable redirectUriPatterns
    .refreshTokenValidity(Long | null) // nullable refreshTokenValidity
    .requiredUserGroups(List<String> | null) // nullable requiredUserGroups
    .resourceId|addAllResourceIds(String) // resourceIds elements
    .scope|addAllScopes(String) // scopes elements
    .tokenSalt(String | null) // nullable tokenSalt
    .build();
 

Returns:

A new Client builder