org.osid.proxy

Interface ProxySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getProxyCondition

ProxyCondition getProxyCondition()

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

Returns:

a proxy condiiton

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 is not of this service

Compliance:

mandatory - This method is must be implemented.