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

Interface ExternalServiceManagementService

All Known Implementing Classes:

ExternalServiceManagement

public interface ExternalServiceManagementService

Provides an API to administer data unique to external services

Version:

$Revision: 225 $

Author:

$Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	addActualEndpoint(String serviceId, Endpoint endpoint) Adds an endpoint.
void	deleteActualEndpoint(String serviceId, String url, String userName) Deletes endpoint.
void	disableActualEndpoint(String serviceId, String url, String userName) Invalidates an endpoint.
void	enableActualEndpoint(String serviceId, String url, String userName) Validates an endpoint.
Endpoint[]	listActualEndpoints(String serviceId) Gets a list of the endpoints of the specified service.

Method Detail

listActualEndpoints

Endpoint[] listActualEndpoints(String serviceId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      ServiceNotFoundException,
                                      UnknownException

Gets a list of the endpoints of the specified service.

Parameters:

serviceId - Service ID

Returns:

List of endpoints

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

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed for an unknown reason

addActualEndpoint

void addActualEndpoint(String serviceId,
                     Endpoint endpoint)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              ServiceNotFoundException,
                              UnknownException

Adds an endpoint. Endpoints are differentiated by url and userName. When an endpoint having the same url and userName has already been added, an InvalidParameterException is thrown.

Parameters:

serviceId - Service ID

endpoint - Endpoint

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

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed for an unknown reason

deleteActualEndpoint

void deleteActualEndpoint(String serviceId,
                        String url,
                        String userName)
                          throws AccessLimitExceededException,
                                 EndpointNotFoundException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

Deletes endpoint.

Parameters:

serviceId - Service ID

url - The URL of the endpoint

userName - Username for BASIC authentication at the endpoint

Throws:

AccessLimitExceededException - Violated an access restriction

EndpointNotFoundException - The endpoint could not be found

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed for an unknown reason

enableActualEndpoint

void enableActualEndpoint(String serviceId,
                        String url,
                        String userName)
                          throws AccessLimitExceededException,
                                 EndpointNotFoundException,
                                 InvalidParameterException,
                                 NoAccessPermissionException,
                                 ServiceConfigurationException,
                                 ServiceNotFoundException,
                                 UnknownException

Validates an endpoint.

Parameters:

serviceId - Service ID

url - The URL of the endpoint

userName - Username for BASIC authentication at the endpoint

Throws:

AccessLimitExceededException - Violated an access restriction

EndpointNotFoundException - The endpoint could not be found

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed for an unknown reason

disableActualEndpoint

void disableActualEndpoint(String serviceId,
                         String url,
                         String userName)
                           throws AccessLimitExceededException,
                                  EndpointNotFoundException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  ServiceNotFoundException,
                                  UnknownException

Invalidates an endpoint.

Parameters:

serviceId - Service ID

url - The URL of the endpoint

userName - Username for BASIC authentication at the endpoint

Throws:

AccessLimitExceededException - Violated an access restriction

EndpointNotFoundException - The endpoint could not be found

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service is not set up appropriately

ServiceNotFoundException - The specified service was not found

UnknownException - Process failed for an unknown reason