org.apache.cxf.rs.security.oauth2.common
Class Client

java.lang.Object
  org.apache.cxf.rs.security.oauth2.common.Client

public class Client
extends Object

Represents a registered third-party Client application

Client

public Client(String clientId,
              String clientSecret,
              boolean isConfidential)

Client

public Client(String clientId,
              String clientSecret,
              boolean isConfidential,
              String applicationName,
              String applicationWebUri)

getClientId

public String getClientId()

Gets the client registration id

Returns:

the consumer key

getClientSecret

public String getClientSecret()

Gets the client secret

Returns:

the secret

getApplicationName

public String getApplicationName()

Gets the name of the third-party application this client represents

Returns:

the application name

setApplicationName

public void setApplicationName(String applicationName)

Sets the name of the third-party application this client represents

Parameters:

applicationName - the name

getApplicationWebUri

public String getApplicationWebUri()

Gets the public URI of the third-party application.

Returns:

the application URI

setApplicationWebUri

public void setApplicationWebUri(String applicationWebUri)

Sets the public URI of the third-party application.

Parameters:

applicationWebUri - the application URI

setApplicationDescription

public void setApplicationDescription(String applicationDescription)

Sets the description of the third-party application.

Parameters:

applicationDescription - the description

getApplicationDescription

public String getApplicationDescription()

Gets the description of the third-party application.

Returns:

the application description

setApplicationLogoUri

public void setApplicationLogoUri(String logoPath)

Sets the URI pointing to a logo image of the client application

Parameters:

logoPath - the logo URI

getApplicationLogoUri

public String getApplicationLogoUri()

Get the URI pointing to a logo image of the client application

Returns:

the logo URI

setConfidential

public void setConfidential(boolean isConf)

Sets the confidentiality status of this client application. This can be used to restrict which OAuth2 flows this client can participate in.

Parameters:

isConf - true if the client is confidential

isConfidential

public boolean isConfidential()

Gets the confidentiality status of this client application.

Returns:

the confidentiality status

setRedirectUris

public void setRedirectUris(List<String> redirectUris)

Sets a list of URIs the AuthorizationService may return the authorization code to.

Parameters:

redirectUris - the redirect uris

getRedirectUris

public List<String> getRedirectUris()

Gets a list of URIs the AuthorizationService may return the authorization code to

Returns:

the redirect uris

setAllowedGrantTypes

public void setAllowedGrantTypes(List<String> allowedGrantTypes)

Sets the list of access token grant types this client can use to obtain the access tokens.

Parameters:

allowedGrantTypes - the list of grant types

getAllowedGrantTypes

public List<String> getAllowedGrantTypes()

Gets the list of access token grant types this client can use to obtain the access tokens.

Returns:

the list of grant types

setSubject

public void setSubject(UserSubject subject)

Sets the UserSubject representing this Client authentication, may be setup during the registration.

Parameters:

subject - the user subject

getSubject

public UserSubject getSubject()

Gets the UserSubject representing this Client authentication

Returns:

the user subject