com.sap.it.api.pd

Interface PartnerDirectoryService

All Superinterfaces:

ITApi

public interface PartnerDirectoryService
extends ITApi

Service for accessing the Partner Directory Parameter values, the partner IDs, the alternative partner IDs, and the authorized users of a partner.

Method Summary

Modifier and Type	Method and Description
String	getAlternativePartnerId(String agency, String scheme, String partnerId) Looks-up the alternative partner ID for the triple scheme, agency, partner ID.
List<String>	getAuthorizedUsers(String partnerId) Returns the authorized users of a partner.
Certificate	getCertificateParameter(String parameterId, String partnerId) Returns a X.509 certificate for a binary parameter with content type "crt".
<T> T	getParameter(String parameterId, String partnerId, Class<T> type) Returns the value of a partner directory parameter.
Collection<String>	getParameterIdsMatchingPattern(String patternForParameterId, String partnerId, Class<?> type) Deprecated. use getParameter(String, String, Class) instead. Returns a collection of parameter IDs which match a given pattern and which belong to a given partner. This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache. Allowed pattern wildcards are: _ (underscore) Any one character. Example: '_bc' finds all three-letter IDs which end with 'bc'. % (percent) Any string of zero or more characters. Example: '%es%' finds all IDs containing 'es' anywhere in the ID. Escape character is \ (backslash). The escape character that is put in front of a wildcard character to indicate that the wildcard should be interpreted as a regular character and not as a wildcard. Example: 'a\_1' finds the ID 'a_1'. You cannot use the character '[' or ']' in the pattern. If you use these characters in the pattern you will get an IllegalArgumentException. Do not use this method if you have more than about 800 parameters per partner ID. There is no index for the parameter ID column of the parameter table (the parameter ID length is too long for an index). Therefore the performance of this method will be insufficient if you have too many parameters per partner ID.
<T> Map<String,T>	getParameters(String partnerId, Class<T> type) Deprecated. use getParameter(String, String, Class) instead. Returns the partner directory parameters for a given partner ID and parameter type. This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache.
<T> Map<String,T>	getParametersMatchingPattern(String patternForParameterId, String partnerId, Class<T> type) Deprecated. use getParameter(String, String, Class) instead. Returns the parameters for a given partner whose parameter IDs match a given pattern. This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache. Allowed pattern wildcards are: _ (underscore) Any one character. Example: '_bc' finds all three-letter IDs which end with 'bc'. % (percent) Any string of zero or more characters. Example: '%es%' finds all IDs containing 'es' anywhere in the ID. Escape character is \ (backslash). The escape character that is put in front of a wildcard character to indicate that the wildcard should be interpreted as a regular character and not as a wildcard. Example: 'a\_1' finds the ID 'a_1'. You cannot use the character '[' or ']' in the pattern. If you use these characters in the pattern you will get an IllegalArgumentException. Do not use this method if you have more than about 800 parameters per partner ID. There is no index for the parameter ID column of the parameter table (the parameter ID length is too long for an index). Therefore the performance of this method will be insufficient if you have too many parameters per partner ID.
String	getPartnerId(String agency, String scheme, String alternativePartnerId) Looks-up the partner ID for the triple scheme, agency, alternative partner ID.
String	getPartnerIdOfAuthorizedUser(String authorizedUser) Returns the Partner ID to which a authorized user was assigned to.

Method Detail

getPartnerId

String getPartnerId(String agency,
                    String scheme,
                    String alternativePartnerId)
             throws PartnerDirectoryException

Looks-up the partner ID for the triple scheme, agency, alternative partner ID. The partner ID is needed for the other methods in this class.

Parameters:

agency - issuing agency of the external partner ID

scheme - identification scheme

alternativePartnerId - alternative partner ID

Returns:

partner ID, or null, if no partner ID exists for the specified triple

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if an input argument is null or empty

getAlternativePartnerId

String getAlternativePartnerId(String agency,
                               String scheme,
                               String partnerId)
                        throws PartnerDirectoryException

Looks-up the alternative partner ID for the triple scheme, agency, partner ID.

Parameters:

agency - issuing agency of the alternative partner ID

scheme - identification scheme

partnerId - partner ID

Returns:

alternative partner ID, or null, if no alternative partner ID exists for the specified triple

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if an input argument is null or empty

getParameter

<T> T getParameter(String parameterId,
                   String partnerId,
                   Class<T> type)
            throws PartnerDirectoryException

Returns the value of a partner directory parameter.

Type Parameters:

T - either String or com.sap.it.api.pd.BinaryData

Parameters:

parameterId - ID of the Partner Directory parameter

partnerId - ID of the partner

type - the type of the parameter, supported types are java.lang.String.class for String parameters, com.sap.it.api.pd.BinaryData.class for Binary parameters

Returns:

value of the parameter, or null if the parameter does not exist in the Partner Directory

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if an input argument is null or the given type is not a supported type or if parametrId or partnerId is empty

getParameters

<T> Map<String,T> getParameters(String partnerId,
                                Class<T> type)
                         throws PartnerDirectoryException

Deprecated. use getParameter(String, String, Class) instead.

Returns the partner directory parameters for a given partner ID and parameter type.

This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache.

Type Parameters:

T - either String or com.sap.it.api.pd.BinaryData

Parameters:

partnerId - ID of the Partner

type - the type of the parameters, supported types are java.lang.String.class for String parameters, com.sap.it.api.pd.BinaryData.class for Binary parameters

Returns:

map containing as keys the parameter ID and as values the parameter values; empty map if no parameter exists for the partner

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if an input argument is null or the given type is not a supported type or if parametrId is empty

getParametersMatchingPattern

<T> Map<String,T> getParametersMatchingPattern(String patternForParameterId,
                                               String partnerId,
                                               Class<T> type)
                                        throws PartnerDirectoryException

Deprecated. use getParameter(String, String, Class) instead.

Returns the parameters for a given partner whose parameter IDs match a given pattern.

This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache.

Allowed pattern wildcards are:

• _ (underscore) Any one character. Example: '_bc' finds all three-letter IDs which end with 'bc'.
• % (percent) Any string of zero or more characters. Example: '%es%' finds all IDs containing 'es' anywhere in the ID.

Escape character is \ (backslash). The escape character that is put in front of a wildcard character to indicate that the wildcard should be interpreted as a regular character and not as a wildcard. Example: 'a\_1' finds the ID 'a_1'.

You cannot use the character '[' or ']' in the pattern. If you use these characters in the pattern you will get an IllegalArgumentException.

Do not use this method if you have more than about 800 parameters per partner ID. There is no index for the parameter ID column of the parameter table (the parameter ID length is too long for an index). Therefore the performance of this method will be insufficient if you have too many parameters per partner ID.

Type Parameters:

T - either String or com.sap.it.api.pd.BinaryData

Parameters:

patternForParameterId - pattern for the parameter IDs, if null is specified then all parameters of the partner are returned

partnerId - ID of the partner

type - the type of the parameters, supported types are java.lang.String.class for String parameters, com.sap.it.api.pd.BinaryData.class for Binary Data parameters

Returns:

map containing as keys the parameter ID and as values the parameter values; empty map if no parameter exists for the partner

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if patternForParameterId contains the character '[' or ']', or if the partnerId argument is null, or if the given type is not a supported type

getParameterIdsMatchingPattern

Collection<String> getParameterIdsMatchingPattern(String patternForParameterId,
                                                  String partnerId,
                                                  Class<?> type)
                                           throws PartnerDirectoryException

Deprecated. use getParameter(String, String, Class) instead.

Returns a collection of parameter IDs which match a given pattern and which belong to a given partner.

This method should be used with caution. From a performance perspective, it is better to make many calls which return single values (see method getParameter(String parameterId, String partnerId, Class type)), instead of using this method, because the methods returning single values are caching the values whereas this method does not use a cache.

Allowed pattern wildcards are:

• _ (underscore) Any one character. Example: '_bc' finds all three-letter IDs which end with 'bc'.
• % (percent) Any string of zero or more characters. Example: '%es%' finds all IDs containing 'es' anywhere in the ID.

Escape character is \ (backslash). The escape character that is put in front of a wildcard character to indicate that the wildcard should be interpreted as a regular character and not as a wildcard. Example: 'a\_1' finds the ID 'a_1'.

You cannot use the character '[' or ']' in the pattern. If you use these characters in the pattern you will get an IllegalArgumentException.

Do not use this method if you have more than about 800 parameters per partner ID. There is no index for the parameter ID column of the parameter table (the parameter ID length is too long for an index). Therefore the performance of this method will be insufficient if you have too many parameters per partner ID.

Parameters:

patternForParameterId - pattern for the parameter IDs, if null is specified then all parameter IDs of the partner are returned

partnerId - ID of the partner

type - the type of the parameters, supported types are java.lang.String.class for String parameters, com.sap.it.api.pd.BinaryData.class for Binary Data parameters

Returns:

collection containing the matching parameter IDs or empty collection if no parameter exists which match the pattern and the partner ID

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if patternForParameterId contains the character '[' or ']', or if the partnerId argument is null, or if the given type is not a supported type

getCertificateParameter

Certificate getCertificateParameter(String parameterId,
                                    String partnerId)
                             throws PartnerDirectoryException

Returns a X.509 certificate for a binary parameter with content type "crt".

Parameters:

parameterId - ID of the Partner Directory parameter

partnerId - ID of the partner

Returns:

java.security.cert.X509Certififate instance, or null if the parameter does not exist in the Partner Directory

Throws:

PartnerDirectoryException - if the parameter is not a certificate parameter, or an other error occurs

IllegalArgumentException - if an input argument is null or the given type is not a supported type or if parametrId or partnerId is empty

getPartnerIdOfAuthorizedUser

String getPartnerIdOfAuthorizedUser(String authorizedUser)
                             throws PartnerDirectoryException

Returns the Partner ID to which a authorized user was assigned to. null is returned if no authorized user is found.

Parameters:

authorizedUser - authorized User

Returns:

partner ID or null

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if the input argument is null or empty

getAuthorizedUsers

List<String> getAuthorizedUsers(String partnerId)
                         throws PartnerDirectoryException

Returns the authorized users of a partner.

Parameters:

partnerId - partner ID

Returns:

list of users or empty list if no authorized user exists

Throws:

PartnerDirectoryException - if an error occurs

IllegalArgumentException - if the input argument is null or empty