org.jacorb.orb.iiop
Class IIOPProfile

java.lang.Object
  org.omg.CORBA.LocalObject
      org.omg.ETF._ProfileLocalBase
          org.jacorb.orb.iiop.IIOPProfile

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.apache.avalon.framework.configuration.Configurable, LocalInterface, Object, IDLEntity, Profile, ProfileOperations

public class IIOPProfile
extends _ProfileLocalBase
implements java.lang.Cloneable, org.apache.avalon.framework.configuration.Configurable

Version:

$Id: IIOPProfile.java,v 1.2 2004/07/12 21:28:28 reverbel Exp $

Author:

Andre Spiegel

See Also:

Serialized Form

Constructor Summary

IIOPProfile(byte[] data)

IIOPProfile(IIOPAddress address, byte[] objectKey)

IIOPProfile(IIOPAddress address, byte[] objectKey, int minor)

IIOPProfile(java.lang.String corbaloc)
Constructs an IIOPProfile from a corbaloc URL.

Method Summary

void	addComponent(int tag, byte[] data)
void	addComponent(int tag, java.lang.Object data, java.lang.Class helper)
TaggedProfile	asTaggedProfile()
java.lang.Object	clone()
void	configure(org.apache.avalon.framework.configuration.Configuration configuration)
Profile	copy() This function shall return an equivalent, deep-copy of the profile on the free store.
boolean	equals(java.lang.Object profile)
byte[]	get_object_key()
IIOPAddress	getAddress()
java.util.List	getAlternateAddresses()
java.lang.Object	getComponent(int tag, java.lang.Class helper)
TaggedComponentList	getComponents()
SSL	getSSL()
int	getSSLPort() Returns the port on which SSL is available according to this profile, or -1 if SSL is not supported.
int	getTLSPortFromCSIComponent() If there is a component tagged with TAG_CSI_SEC_MECH_LIST, get the SSL port from this component.
int	hash() To improve the management of a large set of profile instances, the author may provide a hash function using the data in a Profile instance.
int	hashCode()
boolean	is_match(Profile prof) This function shall determine if the passed profile, prof, is a match to this profile.
void	marshal(TaggedProfileHolder tagged_profile, TaggedComponentSeqHolder components) This function marshals the appropriate information for this transport into the tagged profile.
void	patchPrimaryAddress(java.lang.String newHost, int newPort) Replaces the host in this profile's primary address with newHost (if it is not null), and the port with newPort (if it is not -1).
void	set_object_key(byte[] key)
int	tag()
IIOPProfile	to_GIOP_1_0() Returns a copy of this profile that is compatible with GIOP 1.0.
java.lang.String	toString()
Version	version() This attribute shall contain the GIOP version number that this profile supports.

Methods inherited from class org.omg.ETF._ProfileLocalBase

_ids

Methods inherited from class org.omg.CORBA.LocalObject

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_policy_override, validate_connection

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

IIOPProfile

public IIOPProfile(byte[] data)

IIOPProfile

public IIOPProfile(IIOPAddress address,
                   byte[] objectKey)

IIOPProfile

public IIOPProfile(IIOPAddress address,
                   byte[] objectKey,
                   int minor)

IIOPProfile

public IIOPProfile(java.lang.String corbaloc)

Constructs an IIOPProfile from a corbaloc URL. Only to be used from the corbaloc parser.

Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

marshal

public void marshal(TaggedProfileHolder tagged_profile,
                    TaggedComponentSeqHolder components)

This function marshals the appropriate information for this transport into the tagged profile. ORBs will typically need to call the IOR interception points before calling marshal().

Specified by:

marshal in interface ProfileOperations

hash

public int hash()

To improve the management of a large set of profile instances, the author may provide a hash function using the data in a Profile instance. The Profile shall always implement this function and either return a hash number, or 0 (zero) if no hashing is supported.

Specified by:

hash in interface ProfileOperations

copy

public Profile copy()

This function shall return an equivalent, deep-copy of the profile on the free store.

Specified by:

copy in interface ProfileOperations

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

is_match

public boolean is_match(Profile prof)

This function shall determine if the passed profile, prof, is a match to this profile. The specifics of the match are left to the details of the underlying transport, however profiles shall be considered a match, if they would create connections that share the same attributes relevant to the transport setup. Among others, this could include address information (eg. host address) and transport layer characteristics (eg. encryption levels). If a match is found, it shall return true, or false otherwise.

Specified by:

is_match in interface ProfileOperations

version

public Version version()

This attribute shall contain the GIOP version number that this profile supports. It is initialized each time an instance is created.

Specified by:

version in interface ProfileOperations

set_object_key

public void set_object_key(byte[] key)

Specified by:

set_object_key in interface ProfileOperations

tag

public int tag()

Specified by:

tag in interface ProfileOperations

getAddress

public IIOPAddress getAddress()

patchPrimaryAddress

public void patchPrimaryAddress(java.lang.String newHost,
                                int newPort)

Replaces the host in this profile's primary address with newHost (if it is not null), and the port with newPort (if it is not -1).

getAlternateAddresses

public java.util.List getAlternateAddresses()

get_object_key

public byte[] get_object_key()

Specified by:

get_object_key in interface ProfileOperations

getSSL

public SSL getSSL()

getTLSPortFromCSIComponent

public int getTLSPortFromCSIComponent()

If there is a component tagged with TAG_CSI_SEC_MECH_LIST, get the SSL port from this component. Return the SSL port in the TAG_TLS_SEC_TRANS component encapsulated into the transport_mech field of the first CompoundSecMech of the CSI_SEC_MECH_LIST. Return -1 if there is no component tagged with TAG_CSI_SEC_MECH_LIST or if this component specifies no SSL port.

getSSLPort

public int getSSLPort()

Returns the port on which SSL is available according to this profile, or -1 if SSL is not supported.

getComponents

public TaggedComponentList getComponents()

getComponent

public java.lang.Object getComponent(int tag,
                                     java.lang.Class helper)

addComponent

public void addComponent(int tag,
                         java.lang.Object data,
                         java.lang.Class helper)

addComponent

public void addComponent(int tag,
                         byte[] data)

asTaggedProfile

public TaggedProfile asTaggedProfile()

to_GIOP_1_0

public IIOPProfile to_GIOP_1_0()

Returns a copy of this profile that is compatible with GIOP 1.0.

equals

public boolean equals(java.lang.Object profile)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object