org.cloudfoundry.uaa.clients

Class Client.Builder

java.lang.Object

org.cloudfoundry.uaa.clients.Client.Builder

Enclosing class:

Client

public static final class Client.Builder
extends Object

Builds instances of type Client. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
Client.Builder	accessTokenValidity(Long accessTokenValidity) Initializes the value for the accessTokenValidity attribute.
Client.Builder	action(String action) Initializes the value for the action attribute.
Client.Builder	addAllAllowedProviders(Iterable<String> elements) Adds elements to allowedProviders list.
Client.Builder	addAllAuthorities(Iterable<String> elements) Adds elements to authorities list.
Client.Builder	addAllAuthorizedGrantTypes(Iterable<? extends GrantType> elements) Adds elements to authorizedGrantTypes list.
Client.Builder	addAllAutoApproves(Iterable<String> elements) Adds elements to autoApproves list.
Client.Builder	addAllRedirectUriPatterns(Iterable<String> elements) Adds elements to redirectUriPatterns list.
Client.Builder	addAllRequiredUserGroups(Iterable<String> elements) Adds elements to requiredUserGroups list.
Client.Builder	addAllResourceIds(Iterable<String> elements) Adds elements to resourceIds list.
Client.Builder	addAllScopes(Iterable<String> elements) Adds elements to scopes list.
Client.Builder	allowedProvider(String... elements) Adds elements to allowedProviders list.
Client.Builder	allowedProvider(String element) Adds one element to allowedProviders list.
Client.Builder	allowedProviders(Iterable<String> elements) Sets or replaces all elements for allowedProviders list.
Client.Builder	approvalsDeleted(Boolean approvalsDeleted) Initializes the value for the approvalsDeleted attribute.
Client.Builder	authorities(Iterable<String> elements) Sets or replaces all elements for authorities list.
Client.Builder	authority(String... elements) Adds elements to authorities list.
Client.Builder	authority(String element) Adds one element to authorities list.
Client.Builder	authorizedGrantType(GrantType... elements) Adds elements to authorizedGrantTypes list.
Client.Builder	authorizedGrantType(GrantType element) Adds one element to authorizedGrantTypes list.
Client.Builder	authorizedGrantTypes(Iterable<? extends GrantType> elements) Sets or replaces all elements for authorizedGrantTypes list.
Client.Builder	autoApprove(String... elements) Adds elements to autoApproves list.
Client.Builder	autoApprove(String element) Adds one element to autoApproves list.
Client.Builder	autoApproves(Iterable<String> elements) Sets or replaces all elements for autoApproves list.
Client	build() Builds a new Client.
Client.Builder	clientId(String clientId) Initializes the value for the clientId attribute.
Client.Builder	createdWith(String createdWith) Initializes the value for the createdWith attribute.
Client.Builder	from(org.cloudfoundry.uaa.clients.AbstractClient instance) Fill a builder with attribute values from the provided org.cloudfoundry.uaa.clients.AbstractClient instance.
Client.Builder	from(Client instance) Fill a builder with attribute values from the provided Client instance.
Client.Builder	lastModified(Long lastModified) Initializes the value for the lastModified attribute.
Client.Builder	name(String name) Initializes the value for the name attribute.
Client.Builder	redirectUriPattern(String... elements) Adds elements to redirectUriPatterns list.
Client.Builder	redirectUriPattern(String element) Adds one element to redirectUriPatterns list.
Client.Builder	redirectUriPatterns(Iterable<String> elements) Sets or replaces all elements for redirectUriPatterns list.
Client.Builder	refreshTokenValidity(Long refreshTokenValidity) Initializes the value for the refreshTokenValidity attribute.
Client.Builder	requiredUserGroup(String... elements) Adds elements to requiredUserGroups list.
Client.Builder	requiredUserGroup(String element) Adds one element to requiredUserGroups list.
Client.Builder	requiredUserGroups(Iterable<String> elements) Sets or replaces all elements for requiredUserGroups list.
Client.Builder	resourceId(String... elements) Adds elements to resourceIds list.
Client.Builder	resourceId(String element) Adds one element to resourceIds list.
Client.Builder	resourceIds(Iterable<String> elements) Sets or replaces all elements for resourceIds list.
Client.Builder	scope(String... elements) Adds elements to scopes list.
Client.Builder	scope(String element) Adds one element to scopes list.
Client.Builder	scopes(Iterable<String> elements) Sets or replaces all elements for scopes list.
Client.Builder	tokenSalt(String tokenSalt) Initializes the value for the tokenSalt attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Client.Builder from(org.cloudfoundry.uaa.clients.AbstractClient instance)

Fill a builder with attribute values from the provided org.cloudfoundry.uaa.clients.AbstractClient instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final Client.Builder from(Client instance)

Fill a builder with attribute values from the provided Client instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

accessTokenValidity

public final Client.Builder accessTokenValidity(Long accessTokenValidity)

Initializes the value for the accessTokenValidity attribute.

Parameters:

accessTokenValidity - The value for accessTokenValidity (can be null)

Returns:

this builder for use in a chained invocation

action

public final Client.Builder action(String action)

Initializes the value for the action attribute.

Parameters:

action - The value for action (can be null)

Returns:

this builder for use in a chained invocation

allowedProvider

public final Client.Builder allowedProvider(String element)

Adds one element to allowedProviders list.

Parameters:

element - A allowedProviders element

Returns:

this builder for use in a chained invocation

allowedProvider

public final Client.Builder allowedProvider(String... elements)

Adds elements to allowedProviders list.

Parameters:

elements - An array of allowedProviders elements

Returns:

this builder for use in a chained invocation

allowedProviders

public final Client.Builder allowedProviders(Iterable<String> elements)

Sets or replaces all elements for allowedProviders list.

Parameters:

elements - An iterable of allowedProviders elements

Returns:

this builder for use in a chained invocation

addAllAllowedProviders

public final Client.Builder addAllAllowedProviders(Iterable<String> elements)

Adds elements to allowedProviders list.

Parameters:

elements - An iterable of allowedProviders elements

Returns:

this builder for use in a chained invocation

approvalsDeleted

public final Client.Builder approvalsDeleted(Boolean approvalsDeleted)

Initializes the value for the approvalsDeleted attribute.

Parameters:

approvalsDeleted - The value for approvalsDeleted (can be null)

Returns:

this builder for use in a chained invocation

authority

public final Client.Builder authority(String element)

Adds one element to authorities list.

Parameters:

element - A authorities element

Returns:

this builder for use in a chained invocation

authority

public final Client.Builder authority(String... elements)

Adds elements to authorities list.

Parameters:

elements - An array of authorities elements

Returns:

this builder for use in a chained invocation

authorities

public final Client.Builder authorities(Iterable<String> elements)

Sets or replaces all elements for authorities list.

Parameters:

elements - An iterable of authorities elements

Returns:

this builder for use in a chained invocation

addAllAuthorities

public final Client.Builder addAllAuthorities(Iterable<String> elements)

Adds elements to authorities list.

Parameters:

elements - An iterable of authorities elements

Returns:

this builder for use in a chained invocation

authorizedGrantType

public final Client.Builder authorizedGrantType(GrantType element)

Adds one element to authorizedGrantTypes list.

Parameters:

element - A authorizedGrantTypes element

Returns:

this builder for use in a chained invocation

authorizedGrantType

public final Client.Builder authorizedGrantType(GrantType... elements)

Adds elements to authorizedGrantTypes list.

Parameters:

elements - An array of authorizedGrantTypes elements

Returns:

this builder for use in a chained invocation

authorizedGrantTypes

public final Client.Builder authorizedGrantTypes(Iterable<? extends GrantType> elements)

Sets or replaces all elements for authorizedGrantTypes list.

Parameters:

elements - An iterable of authorizedGrantTypes elements

Returns:

this builder for use in a chained invocation

addAllAuthorizedGrantTypes

public final Client.Builder addAllAuthorizedGrantTypes(Iterable<? extends GrantType> elements)

Adds elements to authorizedGrantTypes list.

Parameters:

elements - An iterable of authorizedGrantTypes elements

Returns:

this builder for use in a chained invocation

autoApprove

public final Client.Builder autoApprove(String element)

Adds one element to autoApproves list.

Parameters:

element - A autoApproves element

Returns:

this builder for use in a chained invocation

autoApprove

public final Client.Builder autoApprove(String... elements)

Adds elements to autoApproves list.

Parameters:

elements - An array of autoApproves elements

Returns:

this builder for use in a chained invocation

autoApproves

public final Client.Builder autoApproves(Iterable<String> elements)

Sets or replaces all elements for autoApproves list.

Parameters:

elements - An iterable of autoApproves elements

Returns:

this builder for use in a chained invocation

addAllAutoApproves

public final Client.Builder addAllAutoApproves(Iterable<String> elements)

Adds elements to autoApproves list.

Parameters:

elements - An iterable of autoApproves elements

Returns:

this builder for use in a chained invocation

clientId

public final Client.Builder clientId(String clientId)

Initializes the value for the clientId attribute.

Parameters:

clientId - The value for clientId

Returns:

this builder for use in a chained invocation

createdWith

public final Client.Builder createdWith(String createdWith)

Initializes the value for the createdWith attribute.

Parameters:

createdWith - The value for createdWith (can be null)

Returns:

this builder for use in a chained invocation

lastModified

public final Client.Builder lastModified(Long lastModified)

Initializes the value for the lastModified attribute.

Parameters:

lastModified - The value for lastModified (can be null)

Returns:

this builder for use in a chained invocation

name

public final Client.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name (can be null)

Returns:

this builder for use in a chained invocation

redirectUriPattern

public final Client.Builder redirectUriPattern(String element)

Adds one element to redirectUriPatterns list.

Parameters:

element - A redirectUriPatterns element

Returns:

this builder for use in a chained invocation

redirectUriPattern

public final Client.Builder redirectUriPattern(String... elements)

Adds elements to redirectUriPatterns list.

Parameters:

elements - An array of redirectUriPatterns elements

Returns:

this builder for use in a chained invocation

redirectUriPatterns

public final Client.Builder redirectUriPatterns(Iterable<String> elements)

Sets or replaces all elements for redirectUriPatterns list.

Parameters:

elements - An iterable of redirectUriPatterns elements

Returns:

this builder for use in a chained invocation

addAllRedirectUriPatterns

public final Client.Builder addAllRedirectUriPatterns(Iterable<String> elements)

Adds elements to redirectUriPatterns list.

Parameters:

elements - An iterable of redirectUriPatterns elements

Returns:

this builder for use in a chained invocation

refreshTokenValidity

public final Client.Builder refreshTokenValidity(Long refreshTokenValidity)

Initializes the value for the refreshTokenValidity attribute.

Parameters:

refreshTokenValidity - The value for refreshTokenValidity (can be null)

Returns:

this builder for use in a chained invocation

requiredUserGroup

public final Client.Builder requiredUserGroup(String element)

Adds one element to requiredUserGroups list.

Parameters:

element - A requiredUserGroups element

Returns:

this builder for use in a chained invocation

requiredUserGroup

public final Client.Builder requiredUserGroup(String... elements)

Adds elements to requiredUserGroups list.

Parameters:

elements - An array of requiredUserGroups elements

Returns:

this builder for use in a chained invocation

requiredUserGroups

public final Client.Builder requiredUserGroups(Iterable<String> elements)

Sets or replaces all elements for requiredUserGroups list.

Parameters:

elements - An iterable of requiredUserGroups elements

Returns:

this builder for use in a chained invocation

addAllRequiredUserGroups

public final Client.Builder addAllRequiredUserGroups(Iterable<String> elements)

Adds elements to requiredUserGroups list.

Parameters:

elements - An iterable of requiredUserGroups elements

Returns:

this builder for use in a chained invocation

resourceId

public final Client.Builder resourceId(String element)

Adds one element to resourceIds list.

Parameters:

element - A resourceIds element

Returns:

this builder for use in a chained invocation

resourceId

public final Client.Builder resourceId(String... elements)

Adds elements to resourceIds list.

Parameters:

elements - An array of resourceIds elements

Returns:

this builder for use in a chained invocation

resourceIds

public final Client.Builder resourceIds(Iterable<String> elements)

Sets or replaces all elements for resourceIds list.

Parameters:

elements - An iterable of resourceIds elements

Returns:

this builder for use in a chained invocation

addAllResourceIds

public final Client.Builder addAllResourceIds(Iterable<String> elements)

Adds elements to resourceIds list.

Parameters:

elements - An iterable of resourceIds elements

Returns:

this builder for use in a chained invocation

scope

public final Client.Builder scope(String element)

Adds one element to scopes list.

Parameters:

element - A scopes element

Returns:

this builder for use in a chained invocation

scope

public final Client.Builder scope(String... elements)

Adds elements to scopes list.

Parameters:

elements - An array of scopes elements

Returns:

this builder for use in a chained invocation

scopes

public final Client.Builder scopes(Iterable<String> elements)

Sets or replaces all elements for scopes list.

Parameters:

elements - An iterable of scopes elements

Returns:

this builder for use in a chained invocation

addAllScopes

public final Client.Builder addAllScopes(Iterable<String> elements)

Adds elements to scopes list.

Parameters:

elements - An iterable of scopes elements

Returns:

this builder for use in a chained invocation

tokenSalt

public final Client.Builder tokenSalt(String tokenSalt)

Initializes the value for the tokenSalt attribute.

Parameters:

tokenSalt - The value for tokenSalt (can be null)

Returns:

this builder for use in a chained invocation

build

public Client build()

Builds a new Client.

Returns:

An immutable instance of Client

Throws:

IllegalStateException - if any required attributes are missing