CredentialData Interface

The CredentialData interface represents a single set of credentials.

This page discusses:

The only supported credential format is user name, password, and (optional) domain name. Existence of an instance of this interface does not imply the credentials are available. The isAvailable() method should be used to verify availability before calling the get() methods. The get() methods throw the CredentialNotAvailableException if the credentials are not available.

boolean isAvailable()

Returns TRUE if this credential holds valid user name and password credentials. Returns FALSE if either the user name or the password is not available.

String getUserName() throws CredentialException

Returns the user name associated with this credential. This method throws CredentialNotAvailableException if isAvailable()==false.

char[] getPw() throws CredentialException

Returns the clear text password in the form of a character array. If possible, the caller should avoid converting the array to a string to allow clearing of the password from memory when it is no longer needed. This method throws CredentialNotAvailableException if isAvailable()==false.

String getDomain() throws CredentialException

Returns the domain name in which this credential is valid, if applicable. Only the extended grid Windows credentials will have a domain name. Other credentials will return null. This method throws CredentialNotAvailableException if isAvailable()==false.