jp.go.nict.langrid.service_1_2.foundation.servicemanagement

Interface ServiceManagementService

All Known Implementing Classes:

ServiceManagement

public interface ServiceManagementService

The interface of the service administration service.

Version:

$Revision: 458 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	activateService(String serviceId) Makes service active.
void	addService(String serviceId, ServiceProfile profile, ServiceInstance instance, Attribute[] attributes) Adds service.
void	addServiceAs(String ownerUserId, String serviceId, ServiceProfile profile, ServiceInstance instance, Attribute[] attributes) Sets the user with ownership and adds the service.
void	clear() Erase all services.
void	deactivateService(String serviceId) Makes service inactive.
void	deleteService(String serviceId) Deletes a registered service.
Invocation[]	getExternalInvocations(String serviceId) Gets external service call data.
Attribute[]	getServiceAttributes(String serviceId, String[] attributeNames) Gets service attributes.
ServiceInstance	getServiceInstance(String serviceId) Gets data about the instance of the service.
ServiceProfile	getServiceProfile(String serviceId) Gets the service's profile data.
byte[]	getServiceWsdl(String serviceId) Gets the service's WSDL.
boolean	isServiceActive(String serviceId) Returns whether the service is active or not.
boolean	isServiceVisible(String serviceId) Returns whether the service is visible or not.
ServiceEntrySearchResult	searchServices(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders, String scope) Searches services over the specified conditions, sorts and returns.
ServiceEntryWithCompactLanguageExpressionSearchResult	searchServicesWithCompactLanguageExpression(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders, String scope) Searches services over the specified conditions, sorts and returns.
void	setServiceAttributes(String serviceId, Attribute[] attributes) Sets service attributes.
void	setServiceInstance(String serviceId, ServiceInstance instance) Sets data about the instance of the service.
void	setServiceProfile(String serviceId, ServiceProfile profile) Sets the service's profile data.
void	setServiceVisible(String serviceId, boolean visible) Sets whether the service is visible or not.

Method Detail

clear

void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

Erase all services. Related access logs, access privileges (access denial, access restrictions) will also be deleted.

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

UnknownException - Process failed

searchServices

ServiceEntrySearchResult searchServices(int startIndex,
                                      int maxCount,
                                      MatchingCondition[] conditions,
                                      Order[] orders,
                                      String scope)
                                        throws AccessLimitExceededException,
                                               InvalidParameterException,
                                               NoAccessPermissionException,
                                               ServiceConfigurationException,
                                               UnknownException,
                                               UnsupportedMatchingMethodException

Searches services over the specified conditions, sorts and returns. Searches both simple and compound services. Matching and sort conditions can be set on service profile data, instance data, and attribute data.

Parameters:

startIndex - Starting position of result acquisition

maxCount - Maximum number of acquired results

conditions - Matching conditions. AND search

orders - Sort condition

scope - Object range (scope)("ALL", "MINE", "ACCESSIBLE")

Returns:

From among the search results, the data in the range specified by startIndex and maxCount

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

UnknownException - Process failed for an unknown reason

UnsupportedMatchingMethodException - An unsupported matching method was specified

searchServicesWithCompactLanguageExpression

ServiceEntryWithCompactLanguageExpressionSearchResult searchServicesWithCompactLanguageExpression(int startIndex,
                                                                                                int maxCount,
                                                                                                MatchingCondition[] conditions,
                                                                                                Order[] orders,
                                                                                                String scope)
                                                                                                  throws AccessLimitExceededException,
                                                                                                         InvalidParameterException,
                                                                                                         NoAccessPermissionException,
                                                                                                         ServiceConfigurationException,
                                                                                                         UnknownException,
                                                                                                         UnsupportedMatchingMethodException

Searches services over the specified conditions, sorts and returns. Searches both simple and compound services. Matching and sort conditions can be set on service profile data, instance data, and attribute data.

Parameters:

startIndex - Starting position of result acquisition

maxCount - Maximum number of acquired results

conditions - Matching conditions. AND search

orders - Sort condition

scope - Object range (scope)("ALL", "MINE", "ACCESSIBLE")

Returns:

From among the search results, the data in the range specified by startIndex and maxCount

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

UnknownException - Process failed for an unknown reason

UnsupportedMatchingMethodException - An unsupported matching method was specified

addService

void addService(String serviceId,
              ServiceProfile profile,
              ServiceInstance instance,
              Attribute[] attributes)
                throws AccessLimitExceededException,
                       InvalidParameterException,
                       NoAccessPermissionException,
                       ServiceAlreadyExistsException,
                       ServiceConfigurationException,
                       UnknownException

Adds service.

Parameters:

serviceId - Service ID

profile - Service data

instance - Service instance (Contents differ according to the type of service instance)

attributes - Service's extended attribute data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceAlreadyExistsException - The specified service already exists

ServiceConfigurationException - Process failed because service setup is invalid

UnknownException - Process failed

addServiceAs

void addServiceAs(String ownerUserId,
                String serviceId,
                ServiceProfile profile,
                ServiceInstance instance,
                Attribute[] attributes)
                  throws AccessLimitExceededException,
                         InvalidParameterException,
                         NoAccessPermissionException,
                         ServiceAlreadyExistsException,
                         ServiceConfigurationException,
                         UnknownException

Sets the user with ownership and adds the service.

Parameters:

ownerUserId - User who has ownership

serviceId - Service ID

profile - Service data

instance - Service instance (Contents differ according to the type of service instance)

attributes - Service's extended attribute data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceAlreadyExistsException - The specified service already exists

ServiceConfigurationException - Process failed because service setup is invalid

UnknownException - Process failed

deleteService

void deleteService(String serviceId)
                   throws AccessLimitExceededException,
                          InvalidParameterException,
                          NoAccessPermissionException,
                          ServiceConfigurationException,
                          ServiceNotFoundException,
                          ServiceNotInactiveException,
                          UnknownException

Deletes a registered service.

Parameters:

serviceId - ID of the deleted service

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

ServiceNotInactiveException - The specified service is not inactive

UnknownException - Process failed due to an unknown cause

getServiceProfile

ServiceProfile getServiceProfile(String serviceId)
                                 throws AccessLimitExceededException,
                                        InvalidParameterException,
                                        NoAccessPermissionException,
                                        ServiceConfigurationException,
                                        ServiceNotFoundException,
                                        UnknownException

Gets the service's profile data.

Parameters:

serviceId - Service ID

Returns:

Profile data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

setServiceProfile

void setServiceProfile(String serviceId,
                     ServiceProfile profile)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

Sets the service's profile data.

Parameters:

serviceId - Service ID

profile - Profile data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

getServiceAttributes

Attribute[] getServiceAttributes(String serviceId,
                               String[] attributeNames)
                                 throws AccessLimitExceededException,
                                        InvalidParameterException,
                                        NoAccessPermissionException,
                                        ServiceConfigurationException,
                                        ServiceNotFoundException,
                                        UnknownException

Gets service attributes.

Parameters:

serviceId - Service ID

attributeNames - Array of names of acquired attributes

Returns:

Attribute array

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

setServiceAttributes

void setServiceAttributes(String serviceId,
                        Attribute[] attributes)
                          throws AccessLimitExceededException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

Sets service attributes.

Parameters:

serviceId - Service ID

attributes - Array of attributes to be set

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

getServiceInstance

ServiceInstance getServiceInstance(String serviceId)
                                   throws AccessLimitExceededException,
                                          InvalidParameterException,
                                          NoAccessPermissionException,
                                          ServiceConfigurationException,
                                          ServiceNotFoundException,
                                          UnknownException

Gets data about the instance of the service.

Parameters:

serviceId - Service ID

Returns:

Data concerning instance of service

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

setServiceInstance

void setServiceInstance(String serviceId,
                      ServiceInstance instance)
                        throws AccessLimitExceededException,
                               InvalidParameterException,
                               NoAccessPermissionException,
                               ServiceConfigurationException,
                               ServiceNotFoundException,
                               ServiceNotInactiveException,
                               UnknownException

Sets data about the instance of the service.

Parameters:

serviceId - Service ID

instance - Data relating to the instance of the service

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

ServiceNotInactiveException - The service is not inactive

UnknownException - Process failed due to an unknown cause

getServiceWsdl

byte[] getServiceWsdl(String serviceId)
                      throws AccessLimitExceededException,
                             InvalidParameterException,
                             NoAccessPermissionException,
                             ServiceConfigurationException,
                             ServiceNotFoundException,
                             UnknownException

Gets the service's WSDL.

Parameters:

serviceId - Service ID

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

activateService

void activateService(String serviceId)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            ServiceNotActivatableException,
                            ServiceNotFoundException,
                            UnknownException

Makes service active.

Parameters:

serviceId - Service ID

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotActivatableException - Service cannot be made active

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

deactivateService

void deactivateService(String serviceId)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotDeactivatableException,
                              ServiceNotFoundException,
                              UnknownException

Makes service inactive. Does nothing if already in an inactive state.

Parameters:

serviceId - Service ID

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotDeactivatableException - Service cannot be made inactive

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

isServiceActive

boolean isServiceActive(String serviceId)
                        throws AccessLimitExceededException,
                               InvalidParameterException,
                               NoAccessPermissionException,
                               ServiceConfigurationException,
                               ServiceNotFoundException,
                               UnknownException

Returns whether the service is active or not.

Parameters:

serviceId - Service ID

Returns:

True when active

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

getExternalInvocations

Invocation[] getExternalInvocations(String serviceId)
                                    throws AccessLimitExceededException,
                                           InvalidParameterException,
                                           NoAccessPermissionException,
                                           ServiceConfigurationException,
                                           ServiceNotFoundException,
                                           UnknownException

Gets external service call data.

Parameters:

serviceId - Service ID

Returns:

External service call data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

isServiceVisible

boolean isServiceVisible(String serviceId)
                         throws AccessLimitExceededException,
                                InvalidParameterException,
                                NoAccessPermissionException,
                                ServiceConfigurationException,
                                ServiceNotFoundException,
                                UnknownException

Returns whether the service is visible or not.

Parameters:

serviceId - Service ID

Returns:

true when visible

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause

setServiceVisible

void setServiceVisible(String serviceId,
                     boolean visible)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

Sets whether the service is visible or not.

Parameters:

serviceId - Service ID

visible - True when visible

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - Process failed because service setup is invalid

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed due to an unknown cause