net.openwings.component
Class ProvideServiceParameters

java.lang.Object
  net.openwings.component.ProvideServiceParameters

All Implemented Interfaces:

java.io.Serializable

public class ProvideServiceParameters

extends java.lang.Object

implements java.io.Serializable

This class defines an object which can be passed to the provideService() method of the ComponentComplex interface to specify configuration information and behavior relevant to providing services. This includes:

• Attributes of the service (standard and custom)
• User Interfaces that can be attached to the service

This object can be stored in a ProvideServicePolicy to make it configurable at deployment time.

See Also:

ProvideServicePolicy, Serialized Form

Constructor Summary

ProvideServiceParameters()
default constructor

ProvideServiceParameters(java.lang.String serviceName, java.lang.String serialNumber, java.lang.String comment, java.lang.String displayName, java.lang.String iconResource, java.lang.String serviceDescription, UniqueID serviceID, UserInterfaceFactory[] factories, Attribute[] serviceAttributes)
general constructor

Method Summary

void	addServiceAttribute(Attribute attribute) This convenience method adds a service attribute
void	addUserInterfaceFactory(UserInterfaceFactory factory) This convenience method adds a factory
java.lang.String	getComment() This method returns a note that describes some aspect of the service
java.lang.String	getDisplayName() This method returns a name for the service which is intended for users to read, perhaps in a service browser or web browser
java.lang.String	getIconResource() This method returns the name of a resource that is an icon that can be used to depict this service.
java.lang.String	getSerialNumber() This method returns the serial number of the service
Attribute	getServiceAttribute(Attribute attribute) This convenience method retrieves a service attribute
Attribute	getServiceAttribute(java.lang.String attributeName) This convenience method retrieves a service attribute by name
Attribute[]	getServiceAttributes() This method returns attributes that describe a service
java.lang.String	getServiceDescription() This method returns a longer textual description of the service
UniqueID	getServiceID() This method returns the unique identifier that should be used to identify the service when it is provided
java.lang.String	getServiceName() This method returns the name that will be used to describe the service
UserInterfaceFactory[]	getUserInterfaceFactories() This method returns the array of UserInterfaceFactory objects that will be provided along with the service
Attribute	removeServiceAttribute(Attribute attribute) This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list
Attribute	removeServiceAttribute(java.lang.String attributeName) This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list
boolean	removeUserInterfaceFactory(UserInterfaceFactory factory) This convenience method removes a user interface factory return true if the factory was removed from the set
void	setComment(java.lang.String comment) This method sets a note that describes some aspect of the service
void	setDisplayName(java.lang.String displayName) This method sets a name for the service which is intended for users to read, perhaps in a service browser or web browser
void	setIconResource(java.lang.String iconResource) This method sets the the name of a resource that is an icon that can be used to depict this service.
void	setSerialNumber(java.lang.String serialNumber) This method sets the serial number of the service
void	setServiceAttributes(Attribute[] serviceAttributes) This method sets attributes describing a service
void	setServiceDescription(java.lang.String serviceDescription) This method sets a longer textual description of the service
void	setServiceID(UniqueID serviceID) This method sets the unique identifier that should be used to identify the service when it is provided
void	setServiceName(java.lang.String serviceName) This method sets a name that will be used to describe the service
void	setUserInterfaceFactories(UserInterfaceFactory[] factories) This method sets the array of UserInterfaceFactory objects that will be provided along with the service

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvideServiceParameters

public ProvideServiceParameters()

default constructor

ProvideServiceParameters

public ProvideServiceParameters(java.lang.String serviceName,
                                java.lang.String serialNumber,
                                java.lang.String comment,
                                java.lang.String displayName,
                                java.lang.String iconResource,
                                java.lang.String serviceDescription,
                                UniqueID serviceID,
                                UserInterfaceFactory[] factories,
                                Attribute[] serviceAttributes)

general constructor

Method Detail

setServiceName

public void setServiceName(java.lang.String serviceName)

This method sets a name that will be used to describe the service

Parameters:

serviceName - name of the service

getServiceName

public java.lang.String getServiceName()

This method returns the name that will be used to describe the service

Returns:

name of the service

setSerialNumber

public void setSerialNumber(java.lang.String serialNumber)

This method sets the serial number of the service

Parameters:

serialNumber - serial number

getSerialNumber

public java.lang.String getSerialNumber()

This method returns the serial number of the service

Returns:

serial number

setComment

public void setComment(java.lang.String comment)

This method sets a note that describes some aspect of the service

Parameters:

comment - aspect of the service

getComment

public java.lang.String getComment()

This method returns a note that describes some aspect of the service

Returns:

aspect of the service

setDisplayName

public void setDisplayName(java.lang.String displayName)

This method sets a name for the service which is intended for users to read, perhaps in a service browser or web browser

Parameters:

displayName - displayable name

getDisplayName

public java.lang.String getDisplayName()

This method returns a name for the service which is intended for users to read, perhaps in a service browser or web browser

Returns:

displayable name

setIconResource

public void setIconResource(java.lang.String iconResource)

This method sets the the name of a resource that is an icon that can be used to depict this service. This resource can be loaded using a ClassLoader.

Parameters:

iconResource - name of the resource

getIconResource

public java.lang.String getIconResource()

This method returns the name of a resource that is an icon that can be used to depict this service.

Returns:

name of the resource

setServiceDescription

public void setServiceDescription(java.lang.String serviceDescription)

This method sets a longer textual description of the service

Parameters:

serviceDescription - description of the service

getServiceDescription

public java.lang.String getServiceDescription()

This method returns a longer textual description of the service

Returns:

description

setServiceID

public void setServiceID(UniqueID serviceID)

This method sets the unique identifier that should be used to identify the service when it is provided

Parameters:

serviceID - unique identifier

getServiceID

public UniqueID getServiceID()

This method returns the unique identifier that should be used to identify the service when it is provided

Returns:

unique identifier

setUserInterfaceFactories

public void setUserInterfaceFactories(UserInterfaceFactory[] factories)

This method sets the array of UserInterfaceFactory objects that will be provided along with the service

Parameters:

factories - array of user interface factories. These factories implement UserInterfaceFactory and conform to the user interface factory pattern

getUserInterfaceFactories

public UserInterfaceFactory[] getUserInterfaceFactories()

This method returns the array of UserInterfaceFactory objects that will be provided along with the service

Returns:

array of user interface factories

addUserInterfaceFactory

public void addUserInterfaceFactory(UserInterfaceFactory factory)

This convenience method adds a factory

removeUserInterfaceFactory

public boolean removeUserInterfaceFactory(UserInterfaceFactory factory)

This convenience method removes a user interface factory return true if the factory was removed from the set

setServiceAttributes

public void setServiceAttributes(Attribute[] serviceAttributes)

This method sets attributes describing a service

Parameters:

serviceAttributes - array of attributes

See Also:

Attribute

getServiceAttributes

public Attribute[] getServiceAttributes()

This method returns attributes that describe a service

Returns:

array of attributes

See Also:

Attribute

addServiceAttribute

public void addServiceAttribute(Attribute attribute)

This convenience method adds a service attribute

removeServiceAttribute

public Attribute removeServiceAttribute(Attribute attribute)

This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list

removeServiceAttribute

public Attribute removeServiceAttribute(java.lang.String attributeName)

This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list

getServiceAttribute

public Attribute getServiceAttribute(Attribute attribute)

This convenience method retrieves a service attribute

getServiceAttribute

public Attribute getServiceAttribute(java.lang.String attributeName)

This convenience method retrieves a service attribute by name