Client (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.rs.security.oauth.data.Client

```
public class Client
extends Object
```
Represents a registered third-party consumer

Constructor Summary

Constructors
Constructor and Description
`Client(String consumerId, String secretKey)`
`Client(String consumerId, String secretKey, String applicationName, String applicationURI)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getApplicationDescription()` Gets the description of the third-party application.
`String`	`getApplicationName()` Gets the name of the third-party application this client represents
`String`	`getApplicationURI()` Gets the public URI of the third-party application.
`String`	`getCallbackURI()`
`String`	`getConsumerKey()` Gets the consumer registration id
`String`	`getLoginName()` Gets the optional login name; can be used for enforcing the RBAC rules
`String`	`getLogoUri()`
`AccessToken`	`getPreAuthorizedToken()`
`String`	`getSecretKey()` Gets the secret key
`int`	`hashCode()`
`void`	`setApplicationDescription(String applicationDescription)` Sets the description of the third-party application.
`void`	`setApplicationName(String applicationName)` Sets the name of the third-party application this client represents
`void`	`setApplicationURI(String applicationURI)` Sets the public URI of the third-party application.
`void`	`setCallbackURI(String callbackURI)`
`void`	`setLoginName(String name)` Sets the optional login name
`void`	`setLogoUri(String logoPath)` Sets the uri pointing to a client logo image.
`void`	`setPreAuthorizedToken(AccessToken preAuthorizedToken)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Client
```
public Client(String consumerId,
      String secretKey,
      String applicationName,
      String applicationURI)
```
  - Client
```
public Client(String consumerId,
      String secretKey)
```
- Method Detail
  - getConsumerKey
```
public String getConsumerKey()
```
    Gets the consumer registration id
    
    Returns:
    the consumer key
  - getSecretKey
```
public String getSecretKey()
```
    Gets the secret key
    
    Returns:
    the secret key
  - 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
  - getApplicationURI
```
public String getApplicationURI()
```
    Gets the public URI of the third-party application. For example, this property can be used to validate request token callbacks
    
    Returns:
    the application URI
  - setApplicationURI
```
public void setApplicationURI(String applicationURI)
```
    Sets the public URI of the third-party application.
  - setApplicationDescription
```
public void setApplicationDescription(String applicationDescription)
```
    Sets the description of the third-party application.
  - getApplicationDescription
```
public String getApplicationDescription()
```
    Gets the description of the third-party application.
    
    Returns:
    the application description
  - setLogoUri
```
public void setLogoUri(String logoPath)
```
    Sets the uri pointing to a client logo image. At the moment it must be a relative URI
    
    Parameters:
    logoPath -
  - getLogoUri
```
public String getLogoUri()
```
  - getLoginName
```
public String getLoginName()
```
    Gets the optional login name; can be used for enforcing the RBAC rules
    
    Returns:
    the login name
  - setLoginName
```
public void setLoginName(String name)
```
    Sets the optional login name
    
    Parameters:
    name - the login name
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setPreAuthorizedToken
```
public void setPreAuthorizedToken(AccessToken preAuthorizedToken)
```
  - getPreAuthorizedToken
```
public AccessToken getPreAuthorizedToken()
```
  - setCallbackURI
```
public void setCallbackURI(String callbackURI)
```
  - getCallbackURI
```
public String getCallbackURI()
```

Class Client

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Client

Client

Method Detail

getConsumerKey

getSecretKey

getApplicationName

setApplicationName

getApplicationURI

setApplicationURI

setApplicationDescription

getApplicationDescription

setLogoUri

getLogoUri

getLoginName

setLoginName

equals

hashCode

setPreAuthorizedToken

getPreAuthorizedToken

setCallbackURI

getCallbackURI