bees.core
Class ExternalCapsule

java.lang.Object
  |
  +--bees.core.ExternalCapsule

public final class ExternalCapsule

extends java.lang.Object

An ExternalCapsule is a class used to carry packets between protocols and applications. Unlike the Capsule class, an ExternalCapsule doesn't have any typing applied to it, the body of the capsule is a raw byte array. In addition, a set of CapabilityEnvelopes and CapabilityReferences can be attached to the ExternalCapsule. These functionality can be used to dynamically transmit new capabilities and reference existing ones.

Constructor Summary

ExternalCapsule()
Construct an empty ExternalCapsule.

ExternalCapsule(CapabilityEnvelope[] ce)
Construct an ExternalCapsule with the given values.

ExternalCapsule(CapabilityEnvelope[] ce, CapabilityReference[] cr)
Construct an ExternalCapsule with the given values.

ExternalCapsule(CapabilityReference[] cr)
Construct an ExternalCapsule with the given values.

Method Summary

CapabilityEnvelope[]	getEnvelopes()
CapabilityReference[]	getReferences()
ProtocolSession	getSession()
ExternalChannel	getSource()
Xdr	getXDR()
ExternalCapsule	init() Initialize a new born capsule.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalCapsule

public ExternalCapsule(CapabilityEnvelope[] ce,
                       CapabilityReference[] cr)

Construct an ExternalCapsule with the given values.

Parameters:

ce - The set of CapabilityEnvelopes to pass to the remote domain.

cr - The set of CapabilityReferences to pass to the remote domain.

ExternalCapsule

public ExternalCapsule(CapabilityEnvelope[] ce)

Construct an ExternalCapsule with the given values.

Parameters:

ce - The set of CapabilityEnvelopes to pass to the remote domain.

ExternalCapsule

public ExternalCapsule(CapabilityReference[] cr)

Construct an ExternalCapsule with the given values.

Parameters:

cr - The set of CapabilityReferences to pass to the remote domain.

ExternalCapsule

public ExternalCapsule()

Construct an empty ExternalCapsule.

Method Detail

getSource

public ExternalChannel getSource()

Returns:

The source of this capsule.

getSession

public ProtocolSession getSession()

getXDR

public Xdr getXDR()

Returns:

The Xdr object used to marshal the body.

getEnvelopes

public CapabilityEnvelope[] getEnvelopes()

Returns:

A set of CapabilityEnvelopes to pass to the remote domain.

getReferences

public CapabilityReference[] getReferences()

Returns:

A set of CapabilityReferencess to pass to the remote domain.

init

public ExternalCapsule init()

Initialize a new born capsule.

Returns:

this

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object