Credentials (Diffusion)

java.lang.Object
- com.pushtechnology.diffusion.api.Credentials

Deprecated.
since 6.4
The Diffusion Publisher API is deprecated and will be removed in a future release.
```
@Deprecated
public final class Credentials
extends Object
```
Authorisation Credentials.
This object remains only for backwards compatibility with ClientListener notifications where the username is the client principal and the password is always null.

Constructor Summary

Constructors
Constructor and Description
`Credentials()` Deprecated. since 6.2 This constructor will be removed in a future release.
`Credentials(String principal)` Deprecated. Create a Credentials object for the specified principal.
`Credentials(String username, String password)` Deprecated. since 6.2 This constructor will be removed in a future release.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`attach(Object attachment)` Deprecated. since 6.2 Credentials attachments no longer serve any purpose. This method will be removed in a future release.
`Object`	`attachment()` Deprecated. since 6.2 Credentials attachments no longer serve any purpose. This method will be removed in a future release.
`String`	`getPassword()` Deprecated. since 6.2 This will always return null unless explicitly set using `setPassword(java.lang.String)`. This method will be removed in a future release.
`String`	`getUsername()` Deprecated. Returns the user name.
`void`	`setPassword(String password)` Deprecated. since 6.2 Mutating this object no longer serves any purpose. This method will be removed in a future release.
`void`	`setUsername(String username)` Deprecated. since 6.2 Mutating this object no longer serves any purpose. This method will be removed in a future release.
`String`	`toString()` Deprecated.

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

- Constructor Detail
  - Credentials
```
@Deprecated
public Credentials()
```
    Deprecated. since 6.2
    This constructor will be removed in a future release.
    
    Create a Credentials object with no user name and password set.
  - Credentials
```
@Deprecated
public Credentials(String username,
                               String password)
```
    Deprecated. since 6.2
    This constructor will be removed in a future release.
    
    Create a Credentials object with specified user name and password.
    
    Parameters:
    
    username - User Name
    
    password - Password
  - Credentials
```
public Credentials(String principal)
```
    Deprecated.
    
    Create a Credentials object for the specified principal.
    
    Parameters:
    
    principal - the principal
- Method Detail
  - attach
```
@Deprecated
public Object attach(Object attachment)
```
    Deprecated. since 6.2
    Credentials attachments no longer serve any purpose. This method will be removed in a future release.
    
    Attaches the given object to the credentials.
    
    Parameters:
    
    attachment - The object to be attached; may be null
    
    Returns:
    
    The previously-attached object, if any, otherwise null
  - attachment
```
@Deprecated
public Object attachment()
```
    Deprecated. since 6.2
    Credentials attachments no longer serve any purpose. This method will be removed in a future release.
    
    Retrieves the current attachment.
    
    Returns:
    
    The object currently attached, or null if there is no attachment
  - getUsername
```
public String getUsername()
```
    Deprecated.
    
    Returns the user name.
    
    Returns:
    
    the user name (principal)
  - getPassword
```
@Deprecated
public String getPassword()
```
    Deprecated. since 6.2
    This will always return null unless explicitly set using setPassword(java.lang.String). This method will be removed in a future release.
    
    Returns the password.
    
    Returns:
    
    the password or null
  - setUsername
```
@Deprecated
public void setUsername(String username)
```
    Deprecated. since 6.2
    Mutating this object no longer serves any purpose. This method will be removed in a future release.
    
    Sets the user name.
    
    Parameters:
    
    username - the user name
  - setPassword
```
@Deprecated
public void setPassword(String password)
```
    Deprecated. since 6.2
    Mutating this object no longer serves any purpose. This method will be removed in a future release.
    
    Sets the password.
    
    Parameters:
    
    password - the password
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object

Class Credentials

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Credentials

Credentials

Credentials

Method Detail

attach

attachment

getUsername

getPassword

setUsername

setPassword

toString