com.epicentric.services
Class GenericService

java.lang.Object
  |
  +--com.epicentric.services.GenericService

All Implemented Interfaces:

Service

Deprecated. in 4.0, to be removed in 8.0 or later. Replaced by a more powerful and generic framework

public abstract class GenericService

extends Object

implements Service

Base-level implementation for the Vignette Portal Service interface. This class should be extended to implement the further functionality necessary in a full Service class.

The start(), stop(), and restart() methods are null implementations.

Constructor Summary

GenericService()
Deprecated.

Method Summary

String	getDescription() Deprecated. Retrieves the service description.
String	getID() Deprecated. Retrieves the service ID.
String	getName() Deprecated. Retrieves the service name.
String	getServiceInfo() Deprecated. Retrieves hard-coded information about the service.
void	init(ServiceConfig config) Deprecated. Initializes the service.
void	restart() Deprecated. Runs stop() and then start().
protected void	setDescription(String description) Deprecated. Sets the service description.
protected void	setID(String id) Deprecated. Sets the service ID.
protected void	setName(String name) Deprecated. Sets the service name.
protected void	setServiceInfo(String info) Deprecated. Sets information about the service.
void	start() Deprecated. Starts the service.
void	stop() Deprecated. Stops the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericService

public GenericService()

Deprecated.

Method Detail

init

public void init(ServiceConfig config)

Deprecated.

Description copied from interface: Service

Initializes the service. Any initialization error conditions should be noted in the service's internal state.

Specified by:

init in interface Service

Following copied from interface: com.epicentric.services.Service

Parameters:

config - ServiceConfig for this Service

start

public void start()
           throws ServiceException

Deprecated.

Description copied from interface: Service

Starts the service. Called after the init() method. In addition to throwing its own exception, this method should throw an appropriate exception for any error condition encountered by init().

Specified by:

start in interface Service

stop

public void stop()

Deprecated.

Description copied from interface: Service

Stops the service. (For some services, a null implementation is appropriate.)

Specified by:

stop in interface Service

restart

public void restart()
             throws ServiceException

Deprecated.

Description copied from interface: Service

Runs stop() and then start().

Specified by:

restart in interface Service

getID

public String getID()

Deprecated.

Description copied from interface: Service

Retrieves the service ID.

Specified by:

getID in interface Service

Following copied from interface: com.epicentric.services.Service

Returns:

service's ID as defined in the properties file

setID

protected void setID(String id)

Deprecated.

Sets the service ID.

Parameters:

id - String ID for this service

getServiceInfo

public String getServiceInfo()

Deprecated.

Description copied from interface: Service

Retrieves hard-coded information about the service.

Specified by:

getServiceInfo in interface Service

Following copied from interface: com.epicentric.services.Service

Returns:

String description of the service.

setServiceInfo

protected void setServiceInfo(String info)

Deprecated.

Sets information about the service.

Parameters:

info - String information about this service

getName

public String getName()

Deprecated.

Description copied from interface: Service

Retrieves the service name.

Specified by:

getName in interface Service

Following copied from interface: com.epicentric.services.Service

Returns:

service's name as defined in the properties file

setName

protected void setName(String name)

Deprecated.

Sets the service name.

Parameters:

name - Name of this service

getDescription

public String getDescription()

Deprecated.

Description copied from interface: Service

Retrieves the service description.

Specified by:

getDescription in interface Service

Following copied from interface: com.epicentric.services.Service

Returns:

service's description as defined in the properties file

setDescription

protected void setDescription(String description)

Deprecated.

Sets the service description.

Parameters:

description - String describing this service