jp.go.nict.langrid.foundation.servicemanagement

Class ServiceManagement

java.lang.Object

jp.go.nict.langrid.foundation.AbstractLangridService

jp.go.nict.langrid.foundation.servicemanagement.ServiceManagement

All Implemented Interfaces:

ServiceManagementService

public class ServiceManagement
extends AbstractLangridService
implements ServiceManagementService

Service administration capabilities.

Version:

$Revision:5259 $

Author:

Takao Nakaguchi, $Author:nakaguchi $

Constructor Summary

Constructors

Constructor and Description
ServiceManagement() Constructor.
ServiceManagement(ServiceContext serviceContext) Constructor.

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.
CompositeServiceEntrySearchResult	searchCompositeServices(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders, String scope) Searches composite services.
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.

Methods inherited from class jp.go.nict.langrid.foundation.AbstractLangridService

adjustDateFieldName, adjustDateFieldName, convert, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertUserOrder, copyAttributes, copyAttributes, copyProperties, getAccessLimitDao, getAccessLogDao, getAccessRightDao, getAccessStateDao, getConverter, getCoreNodeUrl, getDaoContext, getDaoFactory, getDefaultGridId, getFederationDao, getGridDao, getGridId, getNodeDao, getOverUseLimitDao, getOverUseStateDao, getResourceDao, getServiceContext, getServiceDao, getServiceDeploymentDao, getServiceLogic, getSystemPropertyDao, getTargetServiceIds, getTemporaryUserDao, getUserChecker, getUserDao, getUserLogic, unsetFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceManagement

public ServiceManagement()

Constructor.

ServiceManagement

public ServiceManagement(ServiceContext serviceContext)

Constructor.

Parameters:

serviceContext - Service context

Method Detail

clear

@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

Description copied from interface: ServiceManagementService

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

Specified by:

clear in interface ServiceManagementService

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

@AccessRightValidatedMethod
@ValidatedMethod
@TransactionMethod
public ServiceEntrySearchResult searchServices(@IntNotNegative
                                                                                                   int startIndex,
                                                                                                   @IntInRange(minimum=0,maximum=100)
                                                                                                   int maxCount,
                                                                                                   @NotNull@EachElement@ValidMatchingCondition(supportedMatchingMethods={COMPLETE,PARTIAL,PREFIX,SUFFIX,LANGUAGEPATH,IN,EQ,GT,GE,LT,LE})
                                                                                                   MatchingCondition[] conditions,
                                                                                                   @NotNull@EachElement@ValidOrder
                                                                                                   Order[] orders,
                                                                                                   @NotEmpty@ValidEnum(value=Scope.class)
                                                                                                   String scope)
                                        throws AccessLimitExceededException,
                                               InvalidParameterException,
                                               NoAccessPermissionException,
                                               ServiceConfigurationException,
                                               UnknownException,
                                               UnsupportedMatchingMethodException

Description copied from interface: ServiceManagementService

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.

Specified by:

searchServices in interface ServiceManagementService

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

UnsupportedMatchingMethodException - An unsupported matching method was specified

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

UnknownException - Process failed for an unknown reason

searchServicesWithCompactLanguageExpression

@AccessRightValidatedMethod
@ValidatedMethod
@TransactionMethod
public ServiceEntryWithCompactLanguageExpressionSearchResult searchServicesWithCompactLanguageExpression(@IntNotNegative
                                                                                                                                                             int startIndex,
                                                                                                                                                             @IntInRange(minimum=0,maximum=100)
                                                                                                                                                             int maxCount,
                                                                                                                                                             @NotNull@EachElement@ValidMatchingCondition(supportedMatchingMethods={COMPLETE,PARTIAL,PREFIX,SUFFIX,LANGUAGEPATH,IN,EQ,GT,GE,LT,LE})
                                                                                                                                                             MatchingCondition[] conditions,
                                                                                                                                                             @NotNull@EachElement@ValidOrder
                                                                                                                                                             Order[] orders,
                                                                                                                                                             @NotEmpty@ValidEnum(value=Scope.class)
                                                                                                                                                             String scope)
                                                                                                  throws AccessLimitExceededException,
                                                                                                         InvalidParameterException,
                                                                                                         NoAccessPermissionException,
                                                                                                         ServiceConfigurationException,
                                                                                                         UnknownException,
                                                                                                         UnsupportedMatchingMethodException

Description copied from interface: ServiceManagementService

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.

Specified by:

searchServicesWithCompactLanguageExpression in interface ServiceManagementService

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

UnsupportedMatchingMethodException - An unsupported matching method was specified

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

UnknownException - Process failed for an unknown reason

searchCompositeServices

@AccessRightValidatedMethod
@ValidatedMethod
@TransactionMethod
public CompositeServiceEntrySearchResult searchCompositeServices(@IntNotNegative
                                                                                                                     int startIndex,
                                                                                                                     @IntInRange(minimum=0,maximum=100)
                                                                                                                     int maxCount,
                                                                                                                     @NotNull@EachElement@ValidMatchingCondition
                                                                                                                     MatchingCondition[] conditions,
                                                                                                                     @NotNull@EachElement@ValidOrder
                                                                                                                     Order[] orders,
                                                                                                                     @NotEmpty@ValidEnum(value=Scope.class)
                                                                                                                     String scope)
                                                          throws AccessLimitExceededException,
                                                                 InvalidParameterException,
                                                                 NoAccessPermissionException,
                                                                 ServiceConfigurationException,
                                                                 UnknownException,
                                                                 UnsupportedMatchingMethodException

Searches composite services.

Matching conditions can be set for the service's profile, instance, and attribute data.

In CompositeServiceEntry, from among the services the composite service refers to, the list of what is registered in the language grid is included (servicesInUse). The service's references are resolved at the time the composite service is registered.

Parameters:

startIndex - Starting position of search results

maxCount - Maximum number of search results

conditions - Matching conditions

orders - Sort direction

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

Returns:

Search results

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

@AccessRightValidatedMethod(policy=ADMINONLY)
@ValidatedMethod
@TransactionMethod
public void addService(@NotEmpty@ValidServiceId
                                                                                          String serviceId,
                                                                                          @NotNull
                                                                                          ServiceProfile profile,
                                                                                          @NotNull
                                                                                          ServiceInstance instance,
                                                                                          @NotNull@EachElement@ValidAttribute
                                                                                          Attribute[] attributes)
                throws AccessLimitExceededException,
                       InvalidParameterException,
                       NoAccessPermissionException,
                       ServiceAlreadyExistsException,
                       ServiceConfigurationException,
                       UnknownException

Adds service.

Process done upon addition:

For existing users, the access privileges of the services to be added will be set. When default access privilege data is included in attributes then they are set,if none it is set to "permitted". Access restrictions are not added at all.

When the added service is a composite service, the targetNamespace of the WSDL file it refers to Existing services are searched by this, and if found, added to the list of referred services. The return value of searchCompositeServices is included in this list. Used when the servicesInUse property of CompositeService is set.

Format of ServiceInstance#instance

In the case of external services, stores the service's WSDL compressed as a jar (filename is "serviceID.wsdl"). If a composite service, the BPEL file ("serviceID.bpel")and the WSDL file group that refers to it Specifies a jar compressed ("foo.wsdl").

Specified by:

addService in interface ServiceManagementService

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

@AccessRightValidatedMethod(policy=ADMINONLY)
@ValidatedMethod
@TransactionMethod
public void addServiceAs(@NotEmpty@ValidUserId
                                                                                            String ownerUserId,
                                                                                            @NotEmpty@ValidServiceId
                                                                                            String serviceId,
                                                                                            @NotNull
                                                                                            ServiceProfile profile,
                                                                                            @NotNull
                                                                                            ServiceInstance instance,
                                                                                            @NotNull@EachElement@ValidAttribute
                                                                                            Attribute[] attributes)
                  throws AccessLimitExceededException,
                         InvalidParameterException,
                         NoAccessPermissionException,
                         ServiceAlreadyExistsException,
                         ServiceConfigurationException,
                         UnknownException

Sets the user with ownership and adds the service.

Process done upon addition:

For existing users, the access privileges of the services to be added will be set. When default access privilege data is included in attributes then they are set,if none it is set to "permitted". Access restrictions are not added at all.

When the added service is a composite service, the targetNamespace of the WSDL file it refers to Existing services are searched by this, and if found, added to the list of referred services. The return value of searchCompositeServices is included in this list. Used when the servicesInUse property of CompositeService is set.

Format of ServiceInstance#instance

In the case of external services, stores the service's WSDL compressed as a jar (filename is "serviceID.wsdl"). If a composite service, the BPEL file ("serviceID.bpel")and the WSDL file group that refers to it Specifies a jar compressed ("foo.wsdl").

Specified by:

addServiceAs in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void deleteService(@NotEmpty@ValidServiceId
                                                                                                                 String serviceId)
                   throws AccessLimitExceededException,
                          InvalidParameterException,
                          NoAccessPermissionException,
                          ServiceConfigurationException,
                          ServiceNotFoundException,
                          ServiceNotInactiveException,
                          UnknownException

Description copied from interface: ServiceManagementService

Deletes a registered service.

Specified by:

deleteService in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public ServiceProfile getServiceProfile(@NotEmpty@ValidServiceId
                                                                                            String serviceId)
                                 throws AccessLimitExceededException,
                                        InvalidParameterException,
                                        NoAccessPermissionException,
                                        ServiceConfigurationException,
                                        ServiceNotFoundException,
                                        UnknownException

Description copied from interface: ServiceManagementService

Gets the service's profile data.

Specified by:

getServiceProfile in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void setServiceProfile(@NotEmpty@ValidServiceId
                                                                                                                     String serviceId,
                                                                                                                     @NotNull
                                                                                                                     ServiceProfile profile)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

Description copied from interface: ServiceManagementService

Sets the service's profile data.

Specified by:

setServiceProfile in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public Attribute[] getServiceAttributes(@NotEmpty@ValidServiceId
                                                                                            String serviceId,
                                                                                            @NotNull@EachElement@ValidAttributeName
                                                                                            String[] attributeNames)
                                 throws AccessLimitExceededException,
                                        InvalidParameterException,
                                        NoAccessPermissionException,
                                        ServiceConfigurationException,
                                        ServiceNotFoundException,
                                        UnknownException

Gets service attributes.

When an attribute name is specified that does not exist in attributeNames, that attribute name is ignored. When an empty string is set, gets all attributes which can be acquired.

Specified by:

getServiceAttributes in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void setServiceAttributes(@NotEmpty@ValidServiceId
                                                                                                                        String serviceId,
                                                                                                                        @NotNull@EachElement@ValidAttribute
                                                                                                                        Attribute[] attributes)
                          throws AccessLimitExceededException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

Sets service attributes.

When the specified attribute's value field is an empty string, that attribute is deleted.

Specified by:

setServiceAttributes in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public ServiceInstance getServiceInstance(@NotEmpty@ValidServiceId
                                                                                                                                 String serviceId)
                                   throws AccessLimitExceededException,
                                          InvalidParameterException,
                                          NoAccessPermissionException,
                                          ServiceConfigurationException,
                                          ServiceNotFoundException,
                                          UnknownException

Description copied from interface: ServiceManagementService

Gets data about the instance of the service.

Specified by:

getServiceInstance in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void setServiceInstance(@NotEmpty@ValidServiceId
                                                                                                                      String serviceId,
                                                                                                                      @NotNull
                                                                                                                      ServiceInstance instance)
                        throws AccessLimitExceededException,
                               InvalidParameterException,
                               NoAccessPermissionException,
                               ServiceConfigurationException,
                               ServiceNotFoundException,
                               ServiceNotInactiveException,
                               UnknownException

Sets data about the instance of the service.

When this API is called against an active service, throws ServiceNotInactiveException.

Specified by:

setServiceInstance in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public byte[] getServiceWsdl(@NotEmpty@ValidServiceId
                                                                                 String serviceId)
                      throws AccessLimitExceededException,
                             InvalidParameterException,
                             NoAccessPermissionException,
                             ServiceConfigurationException,
                             ServiceNotFoundException,
                             UnknownException

Description copied from interface: ServiceManagementService

Gets the service's WSDL.

Specified by:

getServiceWsdl in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void activateService(@NotEmpty@ValidServiceId
                                                                                                                   String serviceId)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            ServiceNotActivatableException,
                            ServiceNotFoundException,
                            UnknownException

Makes service active.

Doesn't do anything when the state is already active.

Specified by:

activateService in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void deactivateService(@NotEmpty@ValidServiceId
                                                                                                 String serviceId)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotDeactivatableException,
                              ServiceNotFoundException,
                              UnknownException

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

Does nothing if already in an inactive state.

Specified by:

deactivateService in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public boolean isServiceActive(@NotEmpty@ValidServiceId
                                                                                   String serviceId)
                        throws AccessLimitExceededException,
                               InvalidParameterException,
                               NoAccessPermissionException,
                               ServiceConfigurationException,
                               ServiceNotFoundException,
                               UnknownException

Description copied from interface: ServiceManagementService

Returns whether the service is active or not.

Specified by:

isServiceActive in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public Invocation[] getExternalInvocations(@NotEmpty@ValidServiceId
                                                                                               String serviceId)
                                    throws AccessLimitExceededException,
                                           InvalidParameterException,
                                           NoAccessPermissionException,
                                           ServiceConfigurationException,
                                           ServiceNotFoundException,
                                           UnknownException

Gets external service call data.

When called against a simple service always returns an empty result.

Specified by:

getExternalInvocations in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN)
@TransactionMethod
public boolean isServiceVisible(@NotEmpty@ValidServiceId
                                                                                                               String serviceId)
                         throws AccessLimitExceededException,
                                InvalidParameterException,
                                NoAccessPermissionException,
                                ServiceConfigurationException,
                                ServiceNotFoundException,
                                UnknownException

Description copied from interface: ServiceManagementService

Returns whether the service is visible or not.

Specified by:

isServiceVisible in interface ServiceManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN)
@TransactionMethod
public void setServiceVisible(@NotEmpty@ValidServiceId
                                                                                                             String serviceId,
                                                                                                             boolean visible)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

Description copied from interface: ServiceManagementService

Sets whether the service is visible or not.

Specified by:

setServiceVisible in interface ServiceManagementService

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