org.ice4j.security

Class LongTermCredentialSession

java.lang.Object

org.ice4j.security.LongTermCredentialSession

All Implemented Interfaces:

CredentialsAuthority

public class LongTermCredentialSession
extends Object
implements CredentialsAuthority

Represents a use of a LongTermCredential and implements CredentialsAuthority for it.

Author:

Lubomir Marinov

Field Summary

Fields

Modifier and Type	Field and Description
private LongTermCredential	longTermCredential The LongTermCredential a use of which is represented by this instance.
private byte[]	nonce The value of the NONCE attribute currently associated with the use of longTermCredential represented by this instance.
private byte[]	realm The realm (i.e.

Constructor Summary

Constructors

Constructor and Description
LongTermCredentialSession(LongTermCredential longTermCredential, byte[] realm) Initializes a new LongTermCredentialSession instance which is to represent a use of a specific LongTermCredential in a specific realm.

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Request request) Adds the Attributes to a specific Request which support the long-term credential mechanism using the LongTermCredential associated with this instance.
boolean	checkLocalUserName(String username) Determines whether username is currently known to this authority
byte[]	getLocalKey(String username) Returns the key (password) that corresponds to the specified local username or user frag, an empty array if there was no password for that username or null if the username is not a local user name recognized by this CredentialsAuthority.
byte[]	getNonce() Gets the value of the NONCE attribute currently associated with the use of the LongTermCredential represented by this instance.
byte[]	getPassword() Gets the password of the LongTermCredential used by this instance.
byte[]	getRealm() Gets the realm (i.e.
byte[]	getRemoteKey(String username, String media) Returns the key (password) that corresponds to the specified remote username or user frag, an empty array if there was no password for that username or null if the username is not a remote user name recognized by this CredentialsAuthority.
byte[]	getUsername() Gets the username of the LongTermCredential used by this instance.
boolean	realmEquals(byte[] realm) Determines whether the realm of this LongTermCredentialSession is equal to a specific realm.
void	setNonce(byte[] nonce) Sets the value of the NONCE attribute to be associated with the use of the LongTermCredential represented by this instance.
boolean	usernameEquals(byte[] username) Determines whether the username of the LongTermCredential used by this instance is equal to a specific username.

Methods inherited from class java.lang.Object

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

Field Detail

longTermCredential

private final LongTermCredential longTermCredential

The LongTermCredential a use of which is represented by this instance.

nonce

private byte[] nonce

The value of the NONCE attribute currently associated with the use of longTermCredential represented by this instance.

realm

private final byte[] realm

The realm (i.e. the value of the REALM attribute) in which a use of longTermCredential is represented by this instance.

Constructor Detail

LongTermCredentialSession

public LongTermCredentialSession(LongTermCredential longTermCredential,
                                 byte[] realm)

Initializes a new LongTermCredentialSession instance which is to represent a use of a specific LongTermCredential in a specific realm.

Parameters:

longTermCredential - the LongTermCredential a use of which is to be represented by the new instance

realm - the realm in which the specified LongTermCredential is to be used

Method Detail

addAttributes

public void addAttributes(Request request)
                   throws StunException

Adds the Attributes to a specific Request which support the long-term credential mechanism using the LongTermCredential associated with this instance.

Parameters:

request - the Request in which the Attribute supporting the STUN long-term credential mechanism are to be added

Throws:

StunException - if anything goes wrong while adding the Attributes to request which support the STUN long-term credential mechanism

checkLocalUserName

public boolean checkLocalUserName(String username)

Determines whether username is currently known to this authority

Specified by:

checkLocalUserName in interface CredentialsAuthority

Parameters:

username - the user name whose validity we'd like to check

Returns:

true if username is known to this CredentialsAuthority; false, otherwise

See Also:

CredentialsAuthority.checkLocalUserName(String)

getLocalKey

public byte[] getLocalKey(String username)

Returns the key (password) that corresponds to the specified local username or user frag, an empty array if there was no password for that username or null if the username is not a local user name recognized by this CredentialsAuthority.

Specified by:

getLocalKey in interface CredentialsAuthority

Parameters:

username - the local user name or user frag whose credentials we'd like to obtain

Returns:

the key (password) that corresponds to the specified local username or user frag, an empty array if there was no password for that username or null if the username is not a local user name recognized by this CredentialsAuthority

See Also:

CredentialsAuthority.getLocalKey(String)

getNonce

public byte[] getNonce()

Gets the value of the NONCE attribute currently associated with the use of the LongTermCredential represented by this instance.

Returns:

the value of the NONCE attribute currently associated with the use of the LongTermCredential represented by this instance

getPassword

public byte[] getPassword()

Gets the password of the LongTermCredential used by this instance.

Returns:

the password of the LongTermCredential used by this instance

getRealm

public byte[] getRealm()

Gets the realm (i.e. the value of the REALM attribute) in which this instance uses the LongTermCredential associated with it.

Returns:

the realm (i.e. the value of the REALM attribute) in which this instance uses the LongTermCredential associated with it

getRemoteKey

public byte[] getRemoteKey(String username,
                           String media)

Returns the key (password) that corresponds to the specified remote username or user frag, an empty array if there was no password for that username or null if the username is not a remote user name recognized by this CredentialsAuthority.

Specified by:

getRemoteKey in interface CredentialsAuthority

Parameters:

username - the remote user name or user frag whose credentials we'd like to obtain

media - not used

Returns:

the key (password) that corresponds to the specified remote username or user frag, an empty array if there was no password for that username or null if the username is not a remote user name recognized by this CredentialsAuthority

See Also:

CredentialsAuthority.getRemoteKey(String, String)

getUsername

public byte[] getUsername()

Gets the username of the LongTermCredential used by this instance.

Returns:

the username of the LongTermCredential used by this instance

realmEquals

public boolean realmEquals(byte[] realm)

Determines whether the realm of this LongTermCredentialSession is equal to a specific realm.

Parameters:

realm - the realm to compare for equality to the realm of this LongTermCredentialSession

Returns:

true if the specified realm is equal to the realm of this LongTermCredentialSession; otherwise, false

setNonce

public void setNonce(byte[] nonce)

Sets the value of the NONCE attribute to be associated with the use of the LongTermCredential represented by this instance.

Parameters:

nonce - the value of the NONCE attribute to be associated with the use of the LongTermCredential represented by this instance

usernameEquals

public boolean usernameEquals(byte[] username)

Determines whether the username of the LongTermCredential used by this instance is equal to a specific username.

Parameters:

username - the username to compare for equality to the username of the LongTermCredential used by this instance

Returns:

true if the specified username is equal to the username of the LongTermCredential used by this instance; otherwise, false