org.openliberty.wsc

Class DiscoveryService

java.lang.Object

org.openliberty.wsc.BaseServiceClient

org.openliberty.wsc.DiscoveryService

public class DiscoveryService
extends BaseServiceClient

This client models communication with an ID-WSF 2.0 Discovery Service and requires a Disco EPR in order to operate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiscoveryService.WSFServiceType An enumeration of services currently supported by the client library

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISCO_QUERY The urn indicating the default DS Action
private static String	IDWSF_20_AUTHENTICATION_SERVICE_URN Authentication Service URN
private static String	IDWSF_20_DISCOVERY_SERVICE_URN Discovery Service URN
private static String	IDWSF_20_ID_SIS_DAP_SERVICE_URN ID-SIS-DAP Directory Access Protocol Service URN
private static String	IDWSF_20_PEOPLE_SERVICE_URN People Service URN
private static String	IDWSF_20_PERSONAL_PROFILE_SERVICE_URN Personal Profile Service URN
protected static Logger	log
private List<RequestedService>	requestedServices stores requested services for discovery

Constructor Summary

Constructors

Constructor and Description
DiscoveryService(DiscoveryService discoveryService, EndpointReference initialEndpointReference)
DiscoveryService(EndpointReference initialEndpointReference) The discovery service EPR is not necessarily supplied by a Discovery Service, therefore a constructor with only an EPR is provided.

Method Summary

Methods

Modifier and Type	Method and Description
void	addARequestedService(RequestedService requestedService) Allows the ClientLib User to add a requested service to the up-coming request
static void	addProviderIDsToRequestedService(String[] providerIDs, RequestedService requestedService) Utility Method to add ProviderID objects to an existing RequestedService
static void	addSecurityMechIDsToRequestedService(String[] securityMechIDs, RequestedService requestedService) Utility Method to add SecurityMechID objects to an existing RequestedService
static void	addServiceTypesToRequestedService(String[] serviceTypes, RequestedService requestedService) Utility Method to add ServiceType objects to an existing RequestedService
static RequestedService	baseRequestedService() Creates a base RequestedService, used by the other Factory methods
void	clearRequestedServices()
static List<EndpointReference>	eprsFromDiscoResponse(WSFMessage message) Utility method to extract the EndpointReferences from the WSFMessage response.
List<EndpointReference>	invoke() This method creates a disco request from the specified EndpointReference generating a ServiceRequest for each ServiceType specified
static RequestedService	requestedServiceForProviderIDs(String[] providerIDs) Factory method that creates a RequestedService and adds the specified providerIDs
static RequestedService	requestedServiceForSecurityMechIDs(String[] securityMechIDs) Factory method that creates a RequestedService and adds the specified SecurityMechIDs
static RequestedService	requestedServiceForServiceTypes(String[] serviceTypes) Factory method that creates a RequestedService from a list of service types
BaseServiceClient	serviceClientForTypeAndEndpointReference(DiscoveryService.WSFServiceType serviceType, EndpointReference endpointReference) Convenience method that returns a Service Client that is supported and enumerated by the ClientLibrary, from this discovery service
static BaseServiceClient	serviceClientForTypeAndEndpointReference(DiscoveryService discoveryService, DiscoveryService.WSFServiceType serviceType, EndpointReference endpointReference) Convenience method that returns a Service Client that is supported and enumerated by the ClientLibrary

Methods inherited from class org.openliberty.wsc.BaseServiceClient

getDiscoveryService, getServiceEndpointReference, getServiceEndpointReferenceStore, isSigningOutgoingMessages, replaceServiceEndpointReference, serviceExplicitlySupportsOption, setDiscoveryService, setServiceEndpointReference, setSigningOutgoingMessages

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static Logger log

IDWSF_20_PERSONAL_PROFILE_SERVICE_URN

private static final String IDWSF_20_PERSONAL_PROFILE_SERVICE_URN

Personal Profile Service URN

NOTE: The Personal Profile Service is based on DST 1.1. For use in this library it was brought up to DST 2.1, which is now a non-conformant version of PP.

There are two URNs in use for PP presently. This library uses the latest one, but has been tested with an older URN. If the older URN is used, then the configuration in the pp-config.xml must be adjusted appropriately for the XML Tooling to work poroperly.

• urn:liberty:id-sis-pp:2005-05 - matches Conor Cahill's OSS Server
• urn:liberty:id-sis-pp:2003-08 - matches SYMLABS Personal Profile Service

See Also:

Constant Field Values

IDWSF_20_PEOPLE_SERVICE_URN

private static final String IDWSF_20_PEOPLE_SERVICE_URN

People Service URN

See Also:

Constant Field Values

IDWSF_20_AUTHENTICATION_SERVICE_URN

private static final String IDWSF_20_AUTHENTICATION_SERVICE_URN

Authentication Service URN

See Also:

Constant Field Values

IDWSF_20_DISCOVERY_SERVICE_URN

private static final String IDWSF_20_DISCOVERY_SERVICE_URN

Discovery Service URN

See Also:

Constant Field Values

IDWSF_20_ID_SIS_DAP_SERVICE_URN

private static final String IDWSF_20_ID_SIS_DAP_SERVICE_URN

ID-SIS-DAP Directory Access Protocol Service URN

See Also:

Constant Field Values

DISCO_QUERY

public static final String DISCO_QUERY

The urn indicating the default DS Action

See Also:

Constant Field Values

requestedServices

private List<RequestedService> requestedServices

stores requested services for discovery

Constructor Detail

DiscoveryService

public DiscoveryService(EndpointReference initialEndpointReference)

The discovery service EPR is not necessarily supplied by a Discovery Service, therefore a constructor with only an EPR is provided.

Parameters:

initialEndpointReference -

DiscoveryService

public DiscoveryService(DiscoveryService discoveryService,
                EndpointReference initialEndpointReference)

Method Detail

requestedServiceForServiceTypes

public static RequestedService requestedServiceForServiceTypes(String[] serviceTypes)

Factory method that creates a RequestedService from a list of service types

Parameters:

serviceTypes -

Returns:

addServiceTypesToRequestedService

public static void addServiceTypesToRequestedService(String[] serviceTypes,
                                     RequestedService requestedService)

Utility Method to add ServiceType objects to an existing RequestedService

Parameters:

requestedService -

providerIDs -

requestedServiceForProviderIDs

public static RequestedService requestedServiceForProviderIDs(String[] providerIDs)

Factory method that creates a RequestedService and adds the specified providerIDs

Parameters:

providerIDs -

Returns:

addProviderIDsToRequestedService

public static void addProviderIDsToRequestedService(String[] providerIDs,
                                    RequestedService requestedService)

Utility Method to add ProviderID objects to an existing RequestedService

Parameters:

requestedService -

providerIDs -

requestedServiceForSecurityMechIDs

public static RequestedService requestedServiceForSecurityMechIDs(String[] securityMechIDs)

Factory method that creates a RequestedService and adds the specified SecurityMechIDs

Parameters:

providerIDs -

Returns:

addSecurityMechIDsToRequestedService

public static void addSecurityMechIDsToRequestedService(String[] securityMechIDs,
                                        RequestedService requestedService)

Utility Method to add SecurityMechID objects to an existing RequestedService

Parameters:

requestedService -

securityMechIDs -

baseRequestedService

public static RequestedService baseRequestedService()

Creates a base RequestedService, used by the other Factory methods

At the moment only Version 2.0 is supported and therefore it is enforced in this method which specifies the 2.0 framework.

Returns:

addARequestedService

public void addARequestedService(RequestedService requestedService)

Allows the ClientLib User to add a requested service to the up-coming request

Parameters:

requestedService -

clearRequestedServices

public void clearRequestedServices()

invoke

public List<EndpointReference> invoke()

This method creates a disco request from the specified EndpointReference generating a ServiceRequest for each ServiceType specified

Parameters:

epr -

serviceTypes -

Returns:

eprsFromDiscoResponse

public static List<EndpointReference> eprsFromDiscoResponse(WSFMessage message)

Utility method to extract the EndpointReferences from the WSFMessage response.

Parameters:

message -

Returns:

a List of EndpointReference objects, or null if there are none

serviceClientForTypeAndEndpointReference

public BaseServiceClient serviceClientForTypeAndEndpointReference(DiscoveryService.WSFServiceType serviceType,
                                                         EndpointReference endpointReference)

Convenience method that returns a Service Client that is supported and enumerated by the ClientLibrary, from this discovery service

Parameters:

serviceType -

endpointReference -

Returns:

serviceClientForTypeAndEndpointReference

public static BaseServiceClient serviceClientForTypeAndEndpointReference(DiscoveryService discoveryService,
                                                         DiscoveryService.WSFServiceType serviceType,
                                                         EndpointReference endpointReference)

Convenience method that returns a Service Client that is supported and enumerated by the ClientLibrary

Parameters:

discoveryService -

serviceType -

endpointReference -

Returns: