org.ice4j.security

Interface CredentialsAuthority

All Known Implementing Classes:

ConnectivityCheckServer, LongTermCredentialSession

public interface CredentialsAuthority

The CredentialsAuthority interface is implemented by applications in order to allow the stack to verify the integrity of incoming messages containing the MessageIntegrityAttribute.

Author:

Emil Ivov

Method Summary

Modifier and Type	Method and Description
boolean	checkLocalUserName(String username) Verifies whether username is currently known to this authority and returns true if so.
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[]	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.

Method Detail

getLocalKey

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.

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.

getRemoteKey

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.

Parameters:

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

media - the media name that we want to get remote key.

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.

checkLocalUserName

boolean checkLocalUserName(String username)

Verifies whether username is currently known to this authority and returns true if so. Returns false otherwise.

Parameters:

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

Returns:

true if username is known to this CredentialsAuthority and false otherwise.