org.osid.authentication.keys

Interface AuthenticationKeysProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

AuthenticationKeysManager, AuthenticationKeysProxyManager

public interface AuthenticationKeysProfile
extends OsidProfile

The AuthenticationKeysProfile describes the interoperability among authentication keys services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getKeyRecordTypes() Gets the supported Key record types.
TypeList	getKeySearchRecordTypes() Gets the supported key search record types.
boolean	supportsKeyAdmin() Tests if a key administrative service is supported.
boolean	supportsKeyAgency() Tests if retrieving mappings of keys and agencies is supported.
boolean	supportsKeyAgencyAssignment() Tests if managing mappings of keys and agencies is supported.
boolean	supportsKeyLookup() Tests if a key lookup service is supported.
boolean	supportsKeyNotification() Tests if key notification is supported.
boolean	supportsKeyRecordType(Type keyRecordType) Tests if the given Key record type is supported.
boolean	supportsKeySearch() Tests if a key search service is supported.
boolean	supportsKeySearchRecordType(Type keySearchRecordType) Tests if the given key search record type is supported.
boolean	supportsKeySmartAgency() Tests if key smart agency is available.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeyLookup

boolean supportsKeyLookup()

Tests if a key lookup service is supported. A key lookup service defines methods to access keys.

Returns:

true if key lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeySearch

boolean supportsKeySearch()

Tests if a key search service is supported.

Returns:

true if key search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeyAdmin

boolean supportsKeyAdmin()

Tests if a key administrative service is supported.

Returns:

true if key admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeyNotification

boolean supportsKeyNotification()

Tests if key notification is supported. Messages may be sent when keys are created, modified, or deleted.

Returns:

true if key notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeyAgency

boolean supportsKeyAgency()

Tests if retrieving mappings of keys and agencies is supported.

Returns:

true if key agency mapping retrieval is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeyAgencyAssignment

boolean supportsKeyAgencyAssignment()

Tests if managing mappings of keys and agencies is supported.

Returns:

true if key agency assignment is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsKeySmartAgency

boolean supportsKeySmartAgency()

Tests if key smart agency is available.

Returns:

true if key smart agency is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

getKeyRecordTypes

TypeList getKeyRecordTypes()

Gets the supported Key record types.

Returns:

a list containing the supported Key record types

Compliance:

mandatory - This method must be implemented.

supportsKeyRecordType

boolean supportsKeyRecordType(Type keyRecordType)

Tests if the given Key record type is supported.

Parameters:

keyRecordType - a Type indicating a Key type

Returns:

true if the given key record Type is supported, false otherwise

Throws:

NullArgumentException - keyRecordType is null

Compliance:

mandatory - This method must be implemented.

getKeySearchRecordTypes

TypeList getKeySearchRecordTypes()

Gets the supported key search record types.

Returns:

a list containing the supported Key search record types

Compliance:

mandatory - This method must be implemented.

supportsKeySearchRecordType

boolean supportsKeySearchRecordType(Type keySearchRecordType)

Tests if the given key search record type is supported.

Parameters:

keySearchRecordType - a Type indicating a Key search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - keySearchRecordType is null

Compliance:

mandatory - This method must be implemented.