Interface ProxySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProxySession
extends OsidSession

This session converts external data into a proxy for use in OSID proxy managers. The external data is specified in the form of a ProxyCondition .

Method Summary

Modifier and Type	Method	Description
Proxy	getProxy(ProxyCondition input)	Gets a proxy.
ProxyCondition	getProxyCondition()	Gets a proxy condition for acquiring a proxy.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getProxyCondition

ProxyCondition getProxyCondition()
                          throws OperationFailedException,
PermissionDeniedException

Gets a proxy condition for acquiring a proxy. A new proxy condition should be acquired for each proxy request.

Returns:

a proxy condiiton

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure making request

Compliance:

mandatory - This method is must be implemented.

getProxy

Proxy getProxy(ProxyCondition input)
        throws OperationFailedException,
PermissionDeniedException

Gets a proxy.

Parameters:

input - a proxy condition

Returns:

a proxy

Throws:

NullArgumentException - input is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - input did not originate from getProxyCondition()

Compliance:

mandatory - This method is must be implemented.