net.cnri.repository.internal

Class InternalOperationContext

java.lang.Object

net.cnri.apps.doserver.DOServerOperationContext

net.cnri.repository.internal.InternalOperationContext

All Implemented Interfaces:

DOOperationContext

public class InternalOperationContext
extends DOServerOperationContext

An context for executing an operation in an InternalRepository. The methods in this class are dictated by server code; there are some methods that may be removed in the future by both the server and this API.

Constructor Summary

Constructors

Constructor and Description
InternalOperationContext(Main serverMain, Caller caller, java.lang.String objectId, java.lang.String operationId, HeaderSet parameters) Constructs this context.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticateCaller() Requests verification of the callers identity.
boolean	authenticateCredential(java.lang.String credentialId) Verify that this client has been granted a credential by the identified entity.
java.lang.String	getCallerID() Returns the identity of the caller.
java.net.InetAddress	getClientAddress()
java.lang.Object	getConnectionMapping(java.lang.Object mappingKey) Returns the object from the connection-level information table that had previously been used as the mappingData parameter for a call to setConnectionMapping with the given mappingKey on the same connection.
java.lang.String[]	getCredentialIDs() Returns a list of unverified IDs that the client claims as credentials.
DOClient	getDOClientWithForwardedAuthentication(java.lang.String callerId) Return a DOClient instance that forwards any authentication challenges back to the DOP client on the other end of this connection.
HeaderSet	getOperationHeaders() Returns the set of headers that were included with the operation request
java.lang.String	getOperationID() Returns the operation that the caller attempted to invoke.
java.lang.String	getServerID() Returns the identity of this repository service
StorageProxy	getStorage() Returns on object that allows operators to access the storage system for the current object.
java.lang.String	getTargetObjectID() Returns the object on which the caller is invoke the operation.
void	performOperation(java.lang.String serverId, java.lang.String newObjectId, java.lang.String newOperationId, HeaderSet params, java.io.InputStream input, java.io.OutputStream output) Performs the specified operation with the identity of the caller, or as the container repository if the forwarding operations are configured to use the repository's own identity for forwarded operations.
void	setConnectionMapping(java.lang.Object mappingKey, java.lang.Object mappingData) Inserts an object into the connection-level information table.

Methods inherited from class net.cnri.apps.doserver.DOServerOperationContext

getLogEntry, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InternalOperationContext

public InternalOperationContext(Main serverMain,
                        Caller caller,
                        java.lang.String objectId,
                        java.lang.String operationId,
                        HeaderSet parameters)

Constructs this context.

Parameters:

serverMain - the server we are running in

caller - information about the caller

objectId - the target of the operation

operationId - the operation to perform

parameters - parameters of the operation

Method Detail

getClientAddress

public java.net.InetAddress getClientAddress()

Specified by:

getClientAddress in class DOServerOperationContext

getCallerID

public java.lang.String getCallerID()

Description copied from interface: DOOperationContext

Returns the identity of the caller.

authenticateCaller

public boolean authenticateCaller()

Description copied from interface: DOOperationContext

Requests verification of the callers identity. Returns true iff the caller's identity has been verified.

getCredentialIDs

public java.lang.String[] getCredentialIDs()

Description copied from interface: DOOperationContext

Returns a list of unverified IDs that the client claims as credentials. Note: These IDs are not yet verified and the caller should call authenticateCredential() with any credential IDs for whom they assign any meaning. Note2: This should only be called after authenticateClient returns.

authenticateCredential

public boolean authenticateCredential(java.lang.String credentialId)

Description copied from interface: DOOperationContext

Verify that this client has been granted a credential by the identified entity. The given credentialID is expected to have come from the list returned by getCredentialIDs(). Returns true iff a verified credential from credentialID was granted to this client.

getConnectionMapping

public java.lang.Object getConnectionMapping(java.lang.Object mappingKey)

Description copied from interface: DOOperationContext

Returns the object from the connection-level information table that had previously been used as the mappingData parameter for a call to setConnectionMapping with the given mappingKey on the same connection. If no such object had been inserted into the table then this will return null.

setConnectionMapping

public void setConnectionMapping(java.lang.Object mappingKey,
                        java.lang.Object mappingData)

Description copied from interface: DOOperationContext

Inserts an object into the connection-level information table. This causes subsequent calls to getConnectionMapping() on the same connection (but not necessarily the same operation) with the same key to return the given data value.

getTargetObjectID

public java.lang.String getTargetObjectID()

Description copied from interface: DOOperationContext

Returns the object on which the caller is invoke the operation.

getServerID

public java.lang.String getServerID()

Description copied from interface: DOOperationContext

Returns the identity of this repository service

getOperationID

public java.lang.String getOperationID()

Description copied from interface: DOOperationContext

Returns the operation that the caller attempted to invoke.

getOperationHeaders

public HeaderSet getOperationHeaders()

Description copied from interface: DOOperationContext

Returns the set of headers that were included with the operation request

getStorage

public StorageProxy getStorage()

Description copied from interface: DOOperationContext

Returns on object that allows operators to access the storage system for the current object.

getDOClientWithForwardedAuthentication

public DOClient getDOClientWithForwardedAuthentication(java.lang.String callerId)

Description copied from class: DOServerOperationContext

Return a DOClient instance that forwards any authentication challenges back to the DOP client on the other end of this connection.

Specified by:

getDOClientWithForwardedAuthentication in class DOServerOperationContext

performOperation

public void performOperation(java.lang.String serverId,
                    java.lang.String newObjectId,
                    java.lang.String newOperationId,
                    HeaderSet params,
                    java.io.InputStream input,
                    java.io.OutputStream output)
                      throws DOException

Description copied from interface: DOOperationContext

Performs the specified operation with the identity of the caller, or as the container repository if the forwarding operations are configured to use the repository's own identity for forwarded operations. If the serverID is null then the DO client that performs this request will resolve the objectID to find the server.

Throws:

DOException