| 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:
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:
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.
|
String getPartnerId(String agency, String scheme, String alternativePartnerId) throws PartnerDirectoryException
agency - issuing agency of the external partner IDscheme - identification schemealternativePartnerId - alternative partner IDnull, if no partner ID exists for the
specified triplePartnerDirectoryException - if an error occursIllegalArgumentException - if an input argument is null or emptyString getAlternativePartnerId(String agency, String scheme, String partnerId) throws PartnerDirectoryException
agency - issuing agency of the alternative partner IDscheme - identification schemepartnerId - partner IDnull, if no alternative
partner ID exists for the specified triplePartnerDirectoryException - if an error occursIllegalArgumentException - if an input argument is null or empty<T> T getParameter(String parameterId, String partnerId, Class<T> type) throws PartnerDirectoryException
T - either String or com.sap.it.api.pd.BinaryDataparameterId - ID of the Partner Directory parameterpartnerId - ID of the partnertype - the type of the parameter, supported types are
java.lang.String.class for String parameters,
com.sap.it.api.pd.BinaryData.class for Binary
parametersnull if the parameter
does not exist in the Partner DirectoryPartnerDirectoryException - if an error occursIllegalArgumentException - if an input argument is null or the given
type is not a supported type or if
parametrId or partnerId is empty<T> Map<String,T> getParameters(String partnerId, Class<T> type) throws PartnerDirectoryException
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 - either String or com.sap.it.api.pd.BinaryDatapartnerId - ID of the Partnertype - the type of the parameters, supported types are
java.lang.String.class for String parameters,
com.sap.it.api.pd.BinaryData.class for Binary
parametersPartnerDirectoryException - if an error occursIllegalArgumentException - if an input argument is null or the given
type is not a supported type or if
parametrId is empty<T> Map<String,T> getParametersMatchingPattern(String patternForParameterId, String partnerId, Class<T> type) throws PartnerDirectoryException
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:
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 - either String or com.sap.it.api.pd.BinaryDatapatternForParameterId - pattern for the parameter IDs, if null is
specified then all parameters of the partner are returnedpartnerId - ID of the partnertype - 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 parametersPartnerDirectoryException - if an error occursIllegalArgumentException - if patternForParameterId contains the character '['
or ']', or if the partnerId argument is
null, or if the given type is not a
supported typeCollection<String> getParameterIdsMatchingPattern(String patternForParameterId, String partnerId, Class<?> type) throws PartnerDirectoryException
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:
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.
patternForParameterId - pattern for the parameter IDs, if null is
specified then all parameter IDs of the partner are returnedpartnerId - ID of the partnertype - 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 parametersPartnerDirectoryException - if an error occursIllegalArgumentException - if patternForParameterId contains the character '['
or ']', or if the partnerId argument is
null, or if the given type is not a
supported typeCertificate getCertificateParameter(String parameterId, String partnerId) throws PartnerDirectoryException
parameterId - ID of the Partner Directory parameterpartnerId - ID of the partnernull
if the parameter does not exist in the Partner DirectoryPartnerDirectoryException - if the parameter is not a certificate parameter, or an other
error occursIllegalArgumentException - if an input argument is null or the given
type is not a supported type or if
parametrId or partnerId is emptyString getPartnerIdOfAuthorizedUser(String authorizedUser) throws PartnerDirectoryException
null is returned if no authorized user is found.authorizedUser - authorized UsernullPartnerDirectoryException - if an error occursIllegalArgumentException - if the input argument is null or emptyList<String> getAuthorizedUsers(String partnerId) throws PartnerDirectoryException
partnerId - partner IDPartnerDirectoryException - if an error occursIllegalArgumentException - if the input argument is null or emptyCopyright © 2020 SAP. All rights reserved.