org.ecoinformatics.seek.ecogrid

Class EcoGridServicesController

java.lang.Object

org.ecoinformatics.seek.ecogrid.EcoGridServicesController

public class EcoGridServicesController
extends java.lang.Object

This class will control the current service user want to search: user can add, remove and update the service list

Author:

leinfelder (modified from jing tao's version)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATEDQUERYSERVICETYPE
static java.lang.String	AUTHSERVICETYPE
protected static java.lang.String	FALSE
static java.lang.String	IDENTIFIERSERVICETYPE
protected static boolean	isDebugging
protected static org.apache.commons.logging.Log	log
static java.lang.String	PUTSERVICETYPE
static java.lang.String	QUERYSERVICETYPE
protected static java.lang.String	TRUE

Method Summary

Modifier and Type	Method and Description
protected DocumentType[]	addNewDocType(DocumentType[] currentArray, java.util.Vector newTypeVector)
void	addService(EcoGridService service) Add a service to service list.
java.lang.String	authenticateForService(EcoGridService service) Provides an authentication credential for the given service object (if possible) Note that there may not be adequate information in the EcoGridServicesController to support authentication for every service.
void	clearServicesList()
void	deleteServicesFile()
static java.util.Vector	filterQueryServicesList(java.util.Vector inputServices) Filters out the non-query services given a list of EcoGridServices
static EcoGridServicesController	getInstance() Method to get an object from this singleton class
java.util.Vector	getQueryServicesList() Finds a list of query services this is a convenience method for the more general form that takes a full list of types
java.util.Vector	getSelectedServicesList() Method to get selected service with selected document types from service list vector.
EcoGridService	getService(java.lang.String endPoint) Used for tying together related services Finds the EcoGridService for a given endpoint
EcoGridService	getService(java.lang.String serviceGroup, java.lang.String serviceType) Finds the EcoGridService for a given serviceGroup/serviceType pairing
Domain	getServiceDomain(EcoGridService service)
java.util.Vector	getServiceGroupList(java.lang.String serviceGroup) Finds a list of services for a given serviceGroup name
java.util.Vector	getServicesList() Method to get the full service list vector
java.util.Vector	getServicesList(java.lang.String serviceType) Finds a list of services for a given serviceType name this is a convenience method for the more general form that takes a full list of types
java.util.Vector	getServicesList(java.util.Vector serviceTypeList) Finds a list of services with serviceTypes in the given type list
protected void	init()
void	mergeServicesList(java.util.Vector newServices) Rather than completely overwriting the existing services, this method allows new services to be merged with the existing ones.
void	print() Print out every service in the list
void	readServices()
static java.util.Vector	registryEntries2EcogridServices(org.ecoinformatics.ecogrid.registry.stub.RegistryEntryType[] list, boolean selectable)
void	removeService(EcoGridService service) Remove a given service from current query service list.
void	setServicesList(java.util.Vector serviceList)
void	updateService(EcoGridService service) Method to update a existed EcoGridService
void	writeServices()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

isDebugging

protected static boolean isDebugging

TRUE

protected static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

protected static final java.lang.String FALSE

See Also:

Constant Field Values

AUTHENTICATEDQUERYSERVICETYPE

public static final java.lang.String AUTHENTICATEDQUERYSERVICETYPE

See Also:

Constant Field Values

QUERYSERVICETYPE

public static final java.lang.String QUERYSERVICETYPE

See Also:

Constant Field Values

AUTHSERVICETYPE

public static final java.lang.String AUTHSERVICETYPE

See Also:

Constant Field Values

PUTSERVICETYPE

public static final java.lang.String PUTSERVICETYPE

See Also:

Constant Field Values

IDENTIFIERSERVICETYPE

public static final java.lang.String IDENTIFIERSERVICETYPE

See Also:

Constant Field Values

Method Detail

getInstance

public static EcoGridServicesController getInstance()

Method to get an object from this singleton class

init

protected void init()

removeService

public void removeService(EcoGridService service)

Remove a given service from current query service list. The key for removing is endpoint. If endpoint is same, we think they are same service

Parameters:

service - EcoGridService

addService

public void addService(EcoGridService service)
                throws InvalidEcoGridServiceException

Add a service to service list. If new service has same endpoints to service already in current. Then we will compare document type array and add new document type into service If the serviceType is not a in our list, it will throw an exception

Parameters:

service - EcoGridService

Throws:

InvalidEcoGridServiceException

clearServicesList

public void clearServicesList()

addNewDocType

protected DocumentType[] addNewDocType(DocumentType[] currentArray,
                                       java.util.Vector newTypeVector)

updateService

public void updateService(EcoGridService service)
                   throws InvalidEcoGridServiceException

Method to update a existed EcoGridService

Parameters:

service - EcoGridService

Throws:

InvalidEcoGridServiceException

getServicesList

public java.util.Vector getServicesList()

Method to get the full service list vector

Returns:

Vector all services in the controller

setServicesList

public void setServicesList(java.util.Vector serviceList)

mergeServicesList

public void mergeServicesList(java.util.Vector newServices)

Rather than completely overwriting the existing services, this method allows new services to be merged with the existing ones. Services with overlapping endpoints are updated to use the other attributes of the new service. If a service (endpoint) is not found in the current list, the new service is added

Parameters:

newServices - list of new EcoGridServices to merge with the existing services

Throws:

InvalidEcoGridServiceException - cascades up from the add() and update() methods used by this method

authenticateForService

public java.lang.String authenticateForService(EcoGridService service)

Provides an authentication credential for the given service object (if possible) Note that there may not be adequate information in the EcoGridServicesController to support authentication for every service. Additionally, authentication is not applicable for all EcoGridService types

Parameters:

service - an any given EcoGridService that might need authentication credentials to use This service must be part of a service group that has registered a valid authentication service that will provide the credential for use by other service types

Returns:

an authentication credential (string) to be used by the service given in parameter

getServiceDomain

public Domain getServiceDomain(EcoGridService service)

Parameters:

service -

getService

public EcoGridService getService(java.lang.String endPoint)

Used for tying together related services Finds the EcoGridService for a given endpoint

Parameters:

endPoint - the URL of the service

Returns:

service object (EcoGridService) that shares the same endPoint

getService

public EcoGridService getService(java.lang.String serviceGroup,
                                 java.lang.String serviceType)

Finds the EcoGridService for a given serviceGroup/serviceType pairing

Parameters:

serviceGroup - the name of the group of services to search within

serviceType - the type of service to locate

Returns:

service that meets the input parameters

getServiceGroupList

public java.util.Vector getServiceGroupList(java.lang.String serviceGroup)

Finds a list of services for a given serviceGroup name

Parameters:

serviceGroup - the name of the group of services to search within

Returns:

list of EcoGridService objects for the given serviceGroup

getServicesList

public java.util.Vector getServicesList(java.lang.String serviceType)

Finds a list of services for a given serviceType name this is a convenience method for the more general form that takes a full list of types

Parameters:

serviceType - the name of the serviceType of services to search within

Returns:

list of EcoGridService objects for the given serviceType

getServicesList

public java.util.Vector getServicesList(java.util.Vector serviceTypeList)

Finds a list of services with serviceTypes in the given type list

Parameters:

serviceTypeList - list of serviceTypes to match on

Returns:

list of EcoGridService objects for the given serviceTypes

getQueryServicesList

public java.util.Vector getQueryServicesList()

Finds a list of query services this is a convenience method for the more general form that takes a full list of types

Returns:

list of EcoGridService objects for querying

getSelectedServicesList

public java.util.Vector getSelectedServicesList()

Method to get selected service with selected document types from service list vector. If a service selected, but without any selected documents, this service couldn't be in this vector

readServices

public void readServices()

deleteServicesFile

public void deleteServicesFile()

writeServices

public void writeServices()
                   throws java.lang.Exception

Throws:

java.lang.Exception

print

public void print()

Print out every service in the list

filterQueryServicesList

public static java.util.Vector filterQueryServicesList(java.util.Vector inputServices)

Filters out the non-query services given a list of EcoGridServices

Parameters:

list - of many different kinds of services

Returns:

list of EcoGridService objects for querying

registryEntries2EcogridServices

public static java.util.Vector registryEntries2EcogridServices(org.ecoinformatics.ecogrid.registry.stub.RegistryEntryType[] list,
                                                               boolean selectable)