XmlRpcKernelClient (AgentScape version 0.9.3, February 11 2012)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.iids.aos.kernel.xmlrpc
Class XmlRpcKernelClient

java.lang.Object
  org.iids.aos.kernel.xmlrpc.XmlRpcKernelClient

All Implemented Interfaces:: AOSapi

public class XmlRpcKernelClient
extends java.lang.Object
implements AOSapi
extends java.lang.Object
implements AOSapi

Converter class that allows the transparent invocation of the kernel primitives over XML-RPC. Use this class to call the kernel from your AppMW. We currently catch UndeclaredThrowableException and turn them into an IPCException. This is valid, as the former exception is thrown when something happens that cannot be mapped to one of the declared exceptions in the AOSapi. A somewhat cleaner solution is to map the unknown exception to an IPCException in the java.lang.reflect.InvocationHandler. As we are currently using AgentScape's general XML-RPC layer, I didn't want to do that.

Author:: arno

Nested Class Summary

Nested classes/interfaces inherited from interface org.iids.aos.kernel.AOSapi
`AOSapi.AcceptResult, AOSapi.ConnectResult, AOSapi.CreateRoleResult, AOSapi.PrepareWaitACResult, AOSapi.SecSuites, AOSapi.WaitACResult`

Field Summary
`protected XmlRpcableAOSapi`	`xkernel`

Fields inherited from interface org.iids.aos.kernel.AOSapi
`ACTP_TLS_PROTOCOL_VERSION, MUX_TLS_PROTOCOL_VERSION, SCID_AUTH_ALGO, SCID_AUTH_KEYSIZE, SCID_CERT_SIGN_ALGO, SCID_DIGEST_ALGO, SCID_DIGEST_ALGO_BITLENGTH, SEGMENT_CERT_SUBTYPE, SEGMENT_DIGEST_ALGO, SEGMENT_DIGEST_ALGO_BITLENGTH, SEGMENT_SIGN_SUBTYPE, SEGMENT_TOC_SUBTYPE, SIGN_TOC_ALGO, SIGN_TOC_CERTTYPE, XDR_ENCODING_CHARSET`

Constructor Summary
`XmlRpcKernelClient(int xmlRpcPort)` Creates a new instance of `KernelClient`

Method Summary
`AOSapi.AcceptResult`	`accept(Cookie cookie, int listenPort, boolean blocking)` Returns the next permitted connection waiting at a listen endpoint.
`protected static void`	`checkLimitSecSuites(java.lang.String[] secSuites)` INTELLIDISPATCH Parameter check methods for intelligent dispatcher
`protected static void`	`checkLimitSubtypeDescr(byte[] subtype, byte[] descr)`
`void`	`close()`
`void`	`closeConnection(Cookie cookie, int connectionID)` Closes a connection.
`void`	`closeListenEndpoint(Cookie cookie, int listenPort)` Destroys a listen endpoint and closes any pending connections that have arrived at the listen endpoint.
`AOSapi.ConnectResult`	`connect(Cookie cookie, Endpoint listenEndpoint, java.lang.String[] secSuites)` Establishes a connection by connecting to a remote listen endpoint.
`int`	`createAgentContainer(Cookie cookie)` Creates an empty agent container.
`Endpoint`	`createListenEndpoint(Cookie cookie, int listenPort, java.lang.String[] secSuites)` Creates a listen endpoint.
`AOSapi.CreateRoleResult`	`createRole(Cookie cookie, RoleBitmap bitmap)` Creates a new role.
`int`	`createSegment(Cookie cookie, int acid, int segmentType, byte[] subtype, byte[] description)` Creates a new empty segment and TOC entry in the given agent container, using the given parameters.
`void`	`deleteAgentContainer(Cookie cookie, int acid)` Deletes an agent container.
`void`	`deleteRole(Cookie cookie, Cookie childCookie)` Deletes an existing role and all kernel resources owned by that role (Agent containers, connection ports, listen ports, other roles etc.)
`void`	`deleteSegment(Cookie cookie, int acid, int segID)` Removes the given segment from the given agent container.
`void`	`finalizeAgentContainer(Cookie cookie, int acid)` Finalizes an agent container: (a) computes checksums of the container's segments and signs the container using the AOS kernel's private key, and (b) writes the TOC, signature and AOS kernel's key certificate to the agent container's finalization segments.
`int`	`getParam(Cookie cookie, java.lang.String parameterName)` Returns the value of an AOS parameter, a positive integer
`void`	`makePersistent(Cookie cookie, int acid, int segID)` Marks the given segment of the given agent container as persistent.
`byte[]`	`peek(Cookie cookie, int connectionID, int max, boolean blocking)` As receive() but leaves the data that was read in the connection.
`AOSapi.PrepareWaitACResult`	`prepareWaitAgentContainer(Cookie cookie, java.lang.String[] secSuites)` Prepares an incoming agent container shipment.
`byte[]`	`readSegment(Cookie cookie, int acid, int segID, int offset, int length)` Reads a number of bytes from the given segment in the given agent container.
`TOCEntry[]`	`readTOC(Cookie cookie, int acid, int offset, int n)` Reads n TOC entries of an agent container, starting at the entry for segment ID 'offset'.
`byte[]`	`receive(Cookie cookie, int connectionID, int max, boolean blocking)` Reads available data from a connection up to a specified maximum.
`void`	`reenableRole(Cookie cookie)` Used to reset the role so that it can be used again.
`SelectSets`	`select(Cookie cookie, SelectSets sets, boolean blocking)` Cf.
`int`	`send(Cookie cookie, int connectionID, byte[] buffer)` Writes data to a connection.
`void`	`shipAgentContainer(Cookie cookie, int acid, Endpoint dest, java.lang.String[] secSuites, TransactionID tid)` Ships a finalized agent container to a remote AOS kernel.
`AOSapi.WaitACResult`	`waitAgentContainer(Cookie cookie, TransactionID[] tids, int blockTime)` Waits for completion of an incoming agent container shipment with any of the given transaction ID.
`int`	`writeSegment(Cookie cookie, int acid, int segID, int offset, byte[] frombuf)` Writes a number of bytes to the given segment in the given agent container.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

xkernel

protected XmlRpcableAOSapi xkernel

Constructor Detail

XmlRpcKernelClient

public XmlRpcKernelClient(int xmlRpcPort)
                   throws CommunicatorException

Creates a new instance of KernelClient

Throws:: CommunicatorException

Method Detail