wt.federation
Class ServiceIdentifier

java.lang.Object
  wt.federation.ServiceIdentifier

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class ServiceIdentifier

extends Object

implements ObjectMappable, Externalizable

Use the newServiceIdentifier static factory method(s), not the ServiceIdentifier constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	CLASS_NAME Label for the attribute.
private static int	CLASS_NAME_UPPER_LIMIT
private String	className
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	ID_SEPARATOR Supported API: true
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SERVICE_NAME Label for the attribute.
private static int	SERVICE_NAME_UPPER_LIMIT
private String	serviceName

Constructor Summary

ServiceIdentifier()

Method Summary

private void	classNameValidate(String a_ClassName)
boolean	equals(Object obj) Return true if a specified object is a serviceIdentifier and its className and serviceName properties match the corresponding values of this object.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getClassName() Gets the value of the attribute: CLASS_NAME.
String	getConceptualClassname() Deprecated.
FederatedService	getService() Return an instance of the service identified by this service identifier.
String	getServiceName() Gets the value of the attribute: SERVICE_NAME.
int	hashCode() Return the hash code of the service identifier.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(String id) Supports initialization, following construction of an instance.
protected void	initialize(String className, String serviceName) Supports initialization, following construction of an instance.
static ServiceIdentifier	newServiceIdentifier() Constructor retuning an instance with null className and serviceName properties.
static ServiceIdentifier	newServiceIdentifier(String id) Constructor returning an instance whose className and serviceName are derviced from the specified identifier.
static ServiceIdentifier	newServiceIdentifier(String className, String serviceName) Constructor returning an instance initialized with the specified className and serviceName property values.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ServiceIdentifier thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	serviceNameValidate(String a_ServiceName)
void	setClassName(String a_ClassName) Sets the value of the attribute: CLASS_NAME.
void	setServiceName(String a_ServiceName) Sets the value of the attribute: SERVICE_NAME.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASS_NAME

public static final String CLASS_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

CLASS_NAME_UPPER_LIMIT

private static int CLASS_NAME_UPPER_LIMIT

className

private String className

SERVICE_NAME

public static final String SERVICE_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SERVICE_NAME_UPPER_LIMIT

private static int SERVICE_NAME_UPPER_LIMIT

serviceName

private String serviceName

ID_SEPARATOR

public static final String ID_SEPARATOR

Supported API: true

See Also:

Constant Field Values

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ServiceIdentifier

public ServiceIdentifier()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ServiceIdentifier thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getClassName

public String getClassName()

Gets the value of the attribute: CLASS_NAME.

Supported API: true

Returns:

String

setClassName

public void setClassName(String a_ClassName)
                  throws WTPropertyVetoException

Sets the value of the attribute: CLASS_NAME.

Supported API: true

Parameters:

a_ClassName -

Throws:

WTPropertyVetoException

classNameValidate

private void classNameValidate(String a_ClassName)
                        throws WTPropertyVetoException

Parameters:

a_ClassName -

Throws:

WTPropertyVetoException

getServiceName

public String getServiceName()

Gets the value of the attribute: SERVICE_NAME.

Supported API: true

Returns:

String

setServiceName

public void setServiceName(String a_ServiceName)
                    throws WTPropertyVetoException

Sets the value of the attribute: SERVICE_NAME.

Supported API: true

Parameters:

a_ServiceName -

Throws:

WTPropertyVetoException

serviceNameValidate

private void serviceNameValidate(String a_ServiceName)
                          throws WTPropertyVetoException

Parameters:

a_ServiceName -

Throws:

WTPropertyVetoException

newServiceIdentifier

public static ServiceIdentifier newServiceIdentifier(String id)
                                              throws FederationServicesException

Constructor returning an instance whose className and serviceName are derviced from the specified identifier. The syntax of the identifier must be className:serviceName.

Supported API: true

Parameters:

id -

Returns:

ServiceIdentifier

Throws:

FederationServicesException

initialize

protected void initialize(String id)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

id -

Throws:

FederationServicesException

newServiceIdentifier

public static ServiceIdentifier newServiceIdentifier(String className,
                                                     String serviceName)
                                              throws FederationServicesException

Constructor returning an instance initialized with the specified className and serviceName property values.

Supported API: true

Parameters:

className -

serviceName -

Returns:

ServiceIdentifier

Throws:

FederationServicesException

initialize

protected void initialize(String className,
                          String serviceName)
                   throws FederationServicesException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

className -

serviceName -

Throws:

FederationServicesException

newServiceIdentifier

public static ServiceIdentifier newServiceIdentifier()
                                              throws WTException

Constructor retuning an instance with null className and serviceName properties.

Supported API: true

Returns:

ServiceIdentifier

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Throws:

WTException

getService

public FederatedService getService()
                            throws FederationServicesException

Return an instance of the service identified by this service identifier.

Supported API: true

Returns:

FederatedService

Throws:

FederationServicesException

equals

public boolean equals(Object obj)

Return true if a specified object is a serviceIdentifier and its className and serviceName properties match the corresponding values of this object.

Supported API: true

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Return the hash code of the service identifier.

Supported API: true

Returns:

int