com.orchestranetworks.service
Class ServiceKey

java.lang.Object
  com.orchestranetworks.service.ServiceKey

public class ServiceKey

extends Object

Identifies a service.

Services are of three natures:

• A built-in service is provided by EBX.Platform (see this class' constants).
• A specific service is declared in the current schema of the context.
• A home service is declared in a module and is available to any branch or version (but can be disabled by means of service permissions).

See Also:

UIHttpManagerComponent

Field Summary

static ServiceKey	CREATE Built-in creation service.
static ServiceKey	MERGE Built-in merge service.
static ServiceKey	OPTIMIZE Built-in optimize and refactor.
static ServiceKey	VALIDATION Built-in validation service.

Method Summary

boolean	equals(Object anObject)
String	format() Returns a persistent identifier of this service key.
static ServiceKey	forModuleServiceName(String moduleName, String serviceName) Returns an identifier of a service defined in a module.
static ServiceKey	forName(String serviceName) Returns an identifier of a service defined in a schema.
String	getModuleName()
String	getName() Returns the name of the service.
String	getServiceName()
int	hashCode()
boolean	isBuiltInService() Returns true if this instance identifies a built-in service.
static ServiceKey	parse(String aString) Returns the service key that corresponds to the string specified.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATE

public static final ServiceKey CREATE

Built-in creation service.

VALIDATION

public static final ServiceKey VALIDATION

Built-in validation service.

MERGE

public static final ServiceKey MERGE

Built-in merge service.

OPTIMIZE

public static final ServiceKey OPTIMIZE

Built-in optimize and refactor.

Method Detail

forName

public static ServiceKey forName(String serviceName)

Returns an identifier of a service defined in a schema.

Parameters:

serviceName - name of the service in the schema (as defined by the attribute /xs:schema/xs:complexType/@name)

forModuleServiceName

public static ServiceKey forModuleServiceName(String moduleName,
                                              String serviceName)

Returns an identifier of a service defined in a module.

Parameters:

moduleName - name of the module (as defined by the element /module/name in document located at /WEB-INF/ebx/module.xml).

serviceName - name of the service in the module (as defined by the attribute /module/services/service/@name in document /WEB-INF/ebx/module.xml).

parse

public static ServiceKey parse(String aString)

Returns the service key that corresponds to the string specified.

The string specified is generally generated by the method format().

Throws:

IllegalArgumentException - if string specified is incorrect.

getModuleName

public String getModuleName()

getServiceName

public String getServiceName()

getName

public String getName()

Returns the name of the service.

format

public String format()

Returns a persistent identifier of this service key.

The persistent identifier can be parsed back by the method parse(String).

equals

public boolean equals(Object anObject)

hashCode

public int hashCode()

isBuiltInService

public boolean isBuiltInService()

Returns true if this instance identifies a built-in service.

toString

public String toString()