net.jini.core.lookup

Class ServiceTemplate

java.lang.Object

net.jini.core.lookup.ServiceTemplate

All Implemented Interfaces:

Serializable, Cloneable

public class ServiceTemplate
extends Object
implements Serializable, Cloneable

Items in the lookup service are matched using instance of this class. A service item (item) matches a service template (tmpl) if: item.serviceID equals tmpl.serviceID (or if tmpl.serviceID is null); and item.service is an instance of every type in tmpl.serviceTypes; and item.attributeSets contains at least one matching entry for each entry template in tmpl.attributeSetTemplates.

An entry matches an entry template if the class of the template is the same as, or a superclass of, the class of the entry, and every non-null field in the template equals the corresponding field of the entry. Every entry can be used to match more than one template. Note that in a service template, for serviceTypes and attributeSetTemplates, a null field is equivalent to an empty array; both represent a wildcard.

Since:

1.0

Author:

Sun Microsystems, Inc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Entry[]	attributeSetTemplates Attribute set templates to match, or null.
ServiceID	serviceID Service ID to match, or null.
Class[]	serviceTypes Service types to match, or null.

Constructor Summary

Constructors

Constructor and Description
ServiceTemplate(AtomicSerial.GetArg arg) Constructor for @AtomicSerial, note that any instances of this should be cloned in a secure stream to prevent an attacker retaining a reference to mutable state.
ServiceTemplate(ServiceID serviceID, Class[] serviceTypes, Entry[] attrSetTemplates) Simple constructor.

Method Summary

Modifier and Type	Method and Description
ServiceTemplate	clone() Clone has been implemented to allow utilities such as net.jini.lookup.ServiceDiscoveryManager to avoid sharing internally stored instances with client code.
String	toString() Returns a String representation of this ServiceTemplate.

Methods inherited from class java.lang.Object

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

Field Detail

serviceID

public ServiceID serviceID

Service ID to match, or null.

serviceTypes

public Class[] serviceTypes

Service types to match, or null.

attributeSetTemplates

public Entry[] attributeSetTemplates

Attribute set templates to match, or null.

Constructor Detail

ServiceTemplate

public ServiceTemplate(AtomicSerial.GetArg arg)
                throws IOException

Constructor for @AtomicSerial, note that any instances of this should be cloned in a secure stream to prevent an attacker retaining a reference to mutable state.

Parameters:

arg - atomic deserialization parameter

Throws:

IOException - if there are I/O errors while reading from GetArg's underlying InputStream

ServiceTemplate

public ServiceTemplate(ServiceID serviceID,
                       Class[] serviceTypes,
                       Entry[] attrSetTemplates)

Simple constructor.

Parameters:

serviceID - service ID to match, or null

serviceTypes - service types to match, or null

attrSetTemplates - attribute set templates to match, or null

Method Detail

clone

public ServiceTemplate clone()

Clone has been implemented to allow utilities such as net.jini.lookup.ServiceDiscoveryManager to avoid sharing internally stored instances with client code.

Overrides:

clone in class Object

Returns:

a clone of the original ServiceTemplate

toString

public String toString()

Returns a String representation of this ServiceTemplate.

Overrides:

toString in class Object

Returns:

String representation of this ServiceTemplate