Rio Project 4.2 API Documentation

org.rioproject.opstring
Class ParsedService

java.lang.Object
  org.rioproject.opstring.GlobalAttrs
      org.rioproject.opstring.ParsedService

public class ParsedService
extends GlobalAttrs

A ParsedService represents the descriptive attributes of a service that has been parsed.

Author:

Dennis Reedy

Field Summary

static String[]	DEFAULT_EXPORT_JARS Default array of export jar names
static String	DEFAULT_SERVICE_INTERFACE Default name of the service interface class
static String	DYNAMIC
static String	FIXED

Fields inherited from class org.rioproject.opstring.GlobalAttrs

artifacts, associations, autoAdvertise, bundles, cluster, codebase, configParms, groupList, initParms, locatorList, logConfigs, organization, provisionConfig

Constructor Summary

ParsedService()
Create a ParsedService

ParsedService(String name)
Create a ParsedService with a descriptive name

ParsedService(String name, GlobalAttrs global)
Create a ParsedService with a descriptive name

Method Summary

String	getComment() Get the comment
ClassBundle	getComponentBundle() Get the Component as ClassBundle object containing the className and resources required to load the component
boolean	getDiscoveryManagementPooling() Get discoPool
ExecDescriptor	getExecDescriptor()
boolean	getFork()
ClassBundle[]	getInterfaceBundles() Get the Interfaces as ClassBundle object containing the className and resources required to load each class
String	getJMXName() Get the name to use for JMX ObjectName
ServiceElement.MachineBoundary	getMachineBoundary() Get the machine boundary value
String	getMaintain() Get the maintain value
Boolean	getMatchOnName() Get whether the provisioning system whould match on the service's name as well as it's interfaces
String	getMaxPerMachine() Get the maxPerMachine value
String	getName() Get the name that the ParsedService has been constructed with
String	getOperationalStringName() Get the OperationalString name
ServiceElement.ProvisionType	getProvisionType() Get the provisioning type of the service
Collection<RuleMap>	getRuleMaps()
ServiceLevelAgreements	getServiceLevelAgreements() Get the ServiceLevelAgreements
StagedData[]	getStagedData()
void	setComment(String comment) Set the comment
void	setComponentBundle(ClassBundle bundle) Set the Component as ClassBundle object containing the className and resources required to load the component
void	setDiscoveryManagementPooling(boolean value) Set discovery management pooling
void	setDiscoveryManagementPooling(String value) Set discovery management pooling
void	setExecDescriptor(ExecDescriptor execDescriptor)
void	setFork(boolean fork)
void	setInterfaceBundles(ClassBundle... bundles) Set the Interfaces as ClassBundle object containing the className and resources required to load each class
void	setInterfaceBundles(List<ClassBundle> bundles) Set the Interfaces as ClassBundle object containing the className and resources required to load each class
void	setJMXName(String name) Set the name to use for JMX ObjectName
void	setMachineBoundary(String boundary) Set the machine boundary value
void	setMaintain(String maintain) Set the maintain value
void	setMatchOnName(boolean value) Set whether the provisioning system should match on the service's name as well as it's interfaces
void	setMatchOnName(String value) Set whether the provisioning system should match on the service's name as well as it's interfaces
void	setMaxPerMachine(String maxPerMachine) Set the maxPerMachine value
void	setName(String name) Set the name for the ParsedService
void	setOperationalStringName(String opStringName) Set the OperationalString name
void	setProvisionType(String value) Set the provisioning type of the service
void	setRuleMaps(Collection<RuleMap> ruleMaps)
void	setServiceLevelAgreements(ServiceLevelAgreements sla) Set the ServiceLevelAgreements
void	setStagedData(StagedData... stagedData)
String	toString() Provide a String output

Methods inherited from class org.rioproject.opstring.GlobalAttrs

addAssociationDescriptor, getAssociationDescriptors, getAutoAdvertise, getCluster, getCodebase, getConfigParameters, getFaultDetectionHandlerBundle, getGroups, getLocators, getLogConfigs, getOrganization, getParameters, getRawConfigParameters, getServiceProvisionConfig, setAutoAdvertise, setCluster, setCodebase, setConfigParameters, setConfigParameters, setFaultDetectionHandlerBundle, setGroups, setGroups, setLocators, setLogConfigs, setOrganization, setParameters, setServiceProvisionConfig

Methods inherited from class java.lang.Object

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

Field Detail

DYNAMIC

public static final String DYNAMIC

See Also:

Constant Field Values

FIXED

public static final String FIXED

See Also:

Constant Field Values

DEFAULT_EXPORT_JARS

public static final String[] DEFAULT_EXPORT_JARS

Default array of export jar names

DEFAULT_SERVICE_INTERFACE

public static final String DEFAULT_SERVICE_INTERFACE

Default name of the service interface class

Constructor Detail

ParsedService

public ParsedService()

Create a ParsedService

ParsedService

public ParsedService(String name)

Create a ParsedService with a descriptive name

Parameters:

name - The name of the service

ParsedService

public ParsedService(String name,
                     GlobalAttrs global)

Create a ParsedService with a descriptive name

Parameters:

name - The name of the service

global - GlobalAttrs containing attributes that should be applied to the ParsedService.

Method Detail

setDiscoveryManagementPooling

public void setDiscoveryManagementPooling(boolean value)

Set discovery management pooling

Parameters:

value - String value for discoPool. If "yes" then true, otherwise false

setDiscoveryManagementPooling

public void setDiscoveryManagementPooling(String value)

Set discovery management pooling

Parameters:

value - String value for discoPool. If "yes" then true, otherwise false

getDiscoveryManagementPooling

public boolean getDiscoveryManagementPooling()

Get discoPool

Returns:

discoPool

setName

public void setName(String name)

Set the name for the ParsedService

Parameters:

name - The name of the service

getName

public String getName()

Get the name that the ParsedService has been constructed with

Returns:

The name of the service

setJMXName

public void setJMXName(String name)

Set the name to use for JMX ObjectName

Parameters:

name - The name to use for JMX ObjectName

getJMXName

public String getJMXName()

Get the name to use for JMX ObjectName

Returns:

The name to use for JMX ObjectName

setComment

public void setComment(String comment)

Set the comment

Parameters:

comment - The comment for the service

getComment

public String getComment()

Get the comment

Returns:

The comment for the service

setOperationalStringName

public void setOperationalStringName(String opStringName)

Set the OperationalString name

Parameters:

opStringName - The OperationalString name the service belongs to

getOperationalStringName

public String getOperationalStringName()

Get the OperationalString name

Returns:

The OperationalString name the service belongs to

setInterfaceBundles

public void setInterfaceBundles(ClassBundle... bundles)

Set the Interfaces as ClassBundle object containing the className and resources required to load each class

Parameters:

bundles - Array of ClassBundle objects

setInterfaceBundles

public void setInterfaceBundles(List<ClassBundle> bundles)

Set the Interfaces as ClassBundle object containing the className and resources required to load each class

Parameters:

bundles - Array of ClassBundle objects

getInterfaceBundles

public ClassBundle[] getInterfaceBundles()

Get the Interfaces as ClassBundle object containing the className and resources required to load each class

Returns:

Array of ClassBundle objects

setComponentBundle

public void setComponentBundle(ClassBundle bundle)

Set the Component as ClassBundle object containing the className and resources required to load the component

Parameters:

bundle - ClassBundle for the component

getComponentBundle

public ClassBundle getComponentBundle()

Get the Component as ClassBundle object containing the className and resources required to load the component

Returns:

ClassBundle for the component

setMaintain

public void setMaintain(String maintain)

Set the maintain value

Parameters:

maintain - The number of service instances to maintain

getMaintain

public String getMaintain()

Get the maintain value

Returns:

The number of services to maintain. If not set this value will be null

setMaxPerMachine

public void setMaxPerMachine(String maxPerMachine)

Set the maxPerMachine value

Parameters:

maxPerMachine - The maximum number of service instances per machine

getMaxPerMachine

public String getMaxPerMachine()

Get the maxPerMachine value

Returns:

The maximum number of service instances per machine. If the maxPerMachine value is 0, then return -1

setMachineBoundary

public void setMachineBoundary(String boundary)

Set the machine boundary value

Parameters:

boundary - The boundary, "physical" or "virtual"

getMachineBoundary

public ServiceElement.MachineBoundary getMachineBoundary()

Get the machine boundary value

Returns:

The machine boundary

setMatchOnName

public void setMatchOnName(String value)

Set whether the provisioning system should match on the service's name as well as it's interfaces

Parameters:

value - If "yes", then true, otherwise false

setMatchOnName

public void setMatchOnName(boolean value)

Set whether the provisioning system should match on the service's name as well as it's interfaces

Parameters:

value - Boolean value, true or false

getMatchOnName

public Boolean getMatchOnName()

Get whether the provisioning system whould match on the service's name as well as it's interfaces

Returns:

If true then match on name as well as interfaces, othwerwise just match on interfaces

setProvisionType

public void setProvisionType(String value)

Set the provisioning type of the service

Parameters:

value - If the value is "dynamic", then the type maps to ServiceElement.ProvisionType.DYNAMIC, if "fixed", then ServiceElement.ProvisionType.FIXED, if "external" then ServiceElement.ProvisionType.EXTERNAL, otherwise throw an IllegalArgumentException

getProvisionType

public ServiceElement.ProvisionType getProvisionType()

Get the provisioning type of the service

Returns:

Either ServiceElement.DYNAMIC, ServiceElement.FIXED or ServiceElement.EXTERNAL

setStagedData

public void setStagedData(StagedData... stagedData)

getStagedData

public StagedData[] getStagedData()

getExecDescriptor

public ExecDescriptor getExecDescriptor()

setExecDescriptor

public void setExecDescriptor(ExecDescriptor execDescriptor)

setServiceLevelAgreements

public void setServiceLevelAgreements(ServiceLevelAgreements sla)

Set the ServiceLevelAgreements

Parameters:

sla - The ServiceLevelAgreements for the service

getServiceLevelAgreements

public ServiceLevelAgreements getServiceLevelAgreements()

Get the ServiceLevelAgreements

Returns:

The ServiceLevelAgreements for the service

getRuleMaps

public Collection<RuleMap> getRuleMaps()

setRuleMaps

public void setRuleMaps(Collection<RuleMap> ruleMaps)

getFork

public boolean getFork()

setFork

public void setFork(boolean fork)

toString

public String toString()

Provide a String output

Overrides:

toString in class Object