|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.liberty.ws.dst.DSTClient
The class DSTClient
provides methods for Liberty
Data Service Template.
Constructor Summary | |
DSTClient(BinarySecurityToken token,
java.lang.String soapURI,
java.lang.String providerID)
Constructor, connects to the data Service using WSS X509
Token |
|
DSTClient(BinarySecurityToken token,
java.lang.String soapURI,
java.lang.String providerID,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse)
Constructor, connects to Data Service with WSS SAML token,
the HttpServletRequest and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed. |
|
DSTClient(ResourceOffering resourceOffering,
java.lang.String providerID,
SSOToken ssoToken)
Creates a data service template client instance. |
|
DSTClient(SecurityAssertion assertion,
java.lang.String soapURI,
java.lang.String providerID)
Constructor, connects to Data Service using WSS SAML Token |
|
DSTClient(SecurityAssertion assertion,
java.lang.String soapURI,
java.lang.String providerID,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse)
Constructor, connects to Data Service with WSS SAML token,
the HttpServletRequest and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed. |
|
DSTClient(java.lang.String soapURI,
java.lang.String providerID)
Constructor, connects to Data Service without WSS token |
|
DSTClient(java.lang.String soapURI,
java.lang.String providerID,
javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse)
Constructor, connects to Data Service without WSS token, the
HttpServletRequest and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed. |
Method Summary | |
java.util.List |
getData(java.util.List items)
Gets data for the specified query items. |
java.util.List |
getModifyResponse(java.util.List modifies)
Performs a list of modifications specified by a list of DSTModify objects (possible on different resource ID). |
java.util.List |
getQueryResponse(java.util.List queries)
Gets query responses for a list of DST queries |
DSTModifyResponse |
modify(DSTModify modify)
Get modify response for the specified modify. |
DSTModifyResponse |
modify(java.util.List items)
Gets response for a list of DST Modifications. |
DSTQueryResponse |
query(DSTQuery query)
Gets QueryResponse for the specified query. |
void |
setClientAuth(boolean value)
Sets the client authentication. |
void |
setClientCert(java.lang.String certAlias)
Sets the alias for the client certificate if the connection is TLS/SSL with client authentication. |
void |
setProviderID(java.lang.String providerID)
Sets the provider ID. |
void |
setResourceID(EncryptedResourceID encResourceID)
Sets the encrypted resource ID to be accessed |
void |
setResourceID(java.lang.String resourceID)
Sets the resource ID to be accessed |
void |
setSOAPAction(java.lang.String action)
Sets SOAP Action such as query or modify |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DSTClient(java.lang.String soapURI, java.lang.String providerID)
WSS
tokensoapURI
- URI of the SOAP end point for this Data service
instanceproviderID
- ID of service provider.public DSTClient(SecurityAssertion assertion, java.lang.String soapURI, java.lang.String providerID)
WSS
SAML Tokenassertion
- WSS
SAML TokensoapURI
- URI of the SOAP end point for this data
service instanceproviderID
- ID of service provider.public DSTClient(BinarySecurityToken token, java.lang.String soapURI, java.lang.String providerID)
WSS X509
Tokentoken
- WSS X.509
Certificate TokensoapURI
- URI of the SOAP end point for this Data
service instanceproviderID
- ID of service provider.public DSTClient(java.lang.String soapURI, java.lang.String providerID, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
WSS
token, the
HttpServletRequest
and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed.soapURI
- URI of the SOAP end point for this Data
service instanceproviderID
- ID of service provider.httpRequest
- HttpServletRequest
object of current
user agent request.httpResponse
- HttpServletResponse
object of current
user agent request.public DSTClient(SecurityAssertion assertion, java.lang.String soapURI, java.lang.String providerID, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
WSS
SAML token,
the HttpServletRequest
and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed.assertion
- WSS
SAML Token.soapURI
- URI of the SOAP end point for this Data service instance.providerID
- ID of service provider.httpRequest
- HttpServletRequest
object of current
user agent request.httpResponse
- HttpServletResponse
object of current
user agent request.public DSTClient(BinarySecurityToken token, java.lang.String soapURI, java.lang.String providerID, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
WSS
SAML token,
the HttpServletRequest
and HttpServletResponse
object of the current request agent will be used for resource owner
interactions if needed.token
- WSS X.509
Certificate TokensoapURI
- URI of the SOAP end point for this Data
service instanceproviderID
- ID of service provider.httpRequest
- HttpServletRequest
object of current
user agent request.httpResponse
- HttpServletResponse
object of current
user agent.public DSTClient(ResourceOffering resourceOffering, java.lang.String providerID, SSOToken ssoToken) throws DSTException
resourceID
, security mechanism and SOAP endpoint defined
in the ResourceOffering
will be used.resourceOffering
- resource offering for this
discovery service instanceproviderID
- ID of this service provider.ssoToken
- Credential of WSC
DSTException
- if the resourceOffering
is not validMethod Detail |
public void setResourceID(java.lang.String resourceID)
resourceID
- resource ID Stringpublic void setResourceID(EncryptedResourceID encResourceID)
encResourceID
- encrypted resource IDpublic void setProviderID(java.lang.String providerID)
providerID
- Provider ID.public void setClientCert(java.lang.String certAlias)
certAlias
- certificate alias namepublic void setSOAPAction(java.lang.String action)
action
- action for this soap requestpublic void setClientAuth(boolean value)
value
- true value to enable client authentication.public java.util.List getData(java.util.List items) throws DSTException, InteractionRedirectException
items
- list of DSTQueryItem
objectDSTData
objects which have one-to-one
correspondence to the list of query items. If no response for
one of the query item, the corresponding return
DSTData
object will be null.DSTException
- if error occurs when trying to get dataInteractionRedirectException
- if user agent is redirected to
Web Service Provider (WSP
) for resource owner
interactionspublic DSTQueryResponse query(DSTQuery query) throws DSTException, InteractionRedirectException
QueryResponse
for the specified query.query
- DSTQuery
object.DSTDQueryResponse
Object.DSTException
- if error occurs when trying to get dataInteractionRedirectException
- if user agent is redirected to
Web Service Provider (WSP
) for resource owner
interactionspublic DSTModifyResponse modify(java.util.List items) throws DSTException, InteractionRedirectException
DST
Modifications.items
- List of DSTModification
objects.DSTModifyResponse
.DSTException
- if error occurs when trying to modify dataInteractionRedirectException
- if user agent is redirected to
Web Service Provider (WSP
) for resource owner
interactions.public DSTModifyResponse modify(DSTModify modify) throws DSTException, InteractionRedirectException
modify
- DSTModify
object.DSTModifyResponse
object.DSTException
- if error occurs when trying to modify dataInteractionRedirectException
- if user agent is redirected to
Web Service Provider (WSP
) for resource owner
interactionspublic java.util.List getQueryResponse(java.util.List queries) throws DSTException, InteractionRedirectException
DST
queriesqueries
- list of DSTQuery
objectsDSTQueryResponse
objects, corresponding
to each DSTQuery
object.DSTException
- if error occurs when trying to get dataInteractionRedirectException
- if interaction is required.public java.util.List getModifyResponse(java.util.List modifies) throws DSTException, InteractionRedirectException
DSTModify
objects (possible on different resource ID).modifies
- list of DSTModify
objects specifying
resource and modifications to be made.DSTModifyResponse object corresponding
to each DSTModify
.- Throws:
DSTException
- if error occurs when trying to modify dataInteractionRedirectException
- if interaction is required.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |