org.osid.authentication.keys

Interface Key

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Key
extends OsidObject

The key represents cryptographic data managed by the authentication service. An Agent maps to a Key and there is only one Key per Agent.

Method Summary

Methods

Modifier and Type	Method and Description
Agent	getAgent() Gets the Agent corresponding to this key.
Id	getAgentId() Gets the AgentId corresponding to this key.
KeyRecord	getKeyRecord(Type keyRecordType) Gets the key record corresponding to the given Key record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAgentId

Id getAgentId()

Gets the AgentId corresponding to this key.

Returns:

the agent Id

Compliance:

mandatory - This method must be implemented.

getAgent

Agent getAgent()
               throws OperationFailedException

Gets the Agent corresponding to this key.

Returns:

the agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getKeyRecord

KeyRecord getKeyRecord(Type keyRecordType)
                       throws OperationFailedException

Gets the key record corresponding to the given Key record Type. This method is used to retrieve an object implementing the requested record. The keyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(keyRecordType) is true .

Parameters:

keyRecordType - a key record type

Returns:

the key record

Throws:

NullArgumentException - keyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(keyRecordType) is false

Compliance:

mandatory - This method must be implemented.