|
OSCI2-StarterKit |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecteu.osci.messagetypes.OSCIMessage
eu.osci.messagetypes.OSCIRequestParent
eu.osci.messagetypes.OSCIRequest
public class OSCIRequest
This class represents the OSCIRequest message. It will send the correct OSCI SOAP message, parses the
incoming SOAP message and creates the object structure.
Copyright © 2010 Freie Hansestadt Bremen.
Created by bremen online services Entwicklungs- und Betriebsgesellschaft mbH & Co. KG.
This library (Starter Kit) can be used by anybody according to the Bremer Lizenz für freie
Softwarebibliotheken. The license terms can be viewed at www.osci.de or can be ordered at the
OSCI-Leitstelle (Die Senatorin für Finanzen, Freie Hansestadt Bremen, Postfach 10 15 40, 28015 Bremen).
Field Summary |
---|
Fields inherited from class eu.osci.messagetypes.OSCIMessage |
---|
text |
Constructor Summary | |
---|---|
OSCIRequest(EndpointLocator endpointLocator,
javax.xml.ws.WebServiceFeature... _features)
Constructor for endpointLocator parameter with all necessary information. |
|
OSCIRequest(OSCIRequestParent parent)
The constructor should be used in case of multiple OSCI messages. |
|
OSCIRequest(java.net.URL _wsdlURL,
javax.xml.namespace.QName _serviceQName,
javax.xml.namespace.QName _portQName,
javax.xml.ws.WebServiceFeature... _features)
Constructor with the necessary parameters. |
Method Summary | |
---|---|
void |
addCompoundResult(org.w3._2002._03.xkms.CompoundResultType compoundResultType)
Adds a certificate check result. |
void |
addRelatesTo(org.w3._2005._08.addressing.RelatesToType _relatesTo)
Sets the addressing 'RelatesTo' attribute on the OSCI message. |
java.util.List<org.w3._2002._03.xkms.CompoundResultType> |
getCompoundResult()
Returns a List of the check results of the certificate checks. |
eu.osci.ws._2008._05.transport.DeliveryReceiptDemandType |
getDeliveryReceiptDemand()
Returns the OSCI DeliveryReceiptDemand header. |
eu.osci.ws._2008._05.transport.FetchedNotificationDemandType |
getFetchedNotificationDemand()
Returns the FetchedNotificationDemand if existing. |
org.w3._2005._08.addressing.MetadataType |
getMetaData()
Returns the set MetaDataType of the incoming message. |
eu.osci.ws._2008._05.transport.MsgTimeStampsType |
getMsgTimeStamps()
Returns the set MsgTimeStampsType or the MsgTimeStampsType of the incoming message in case of synchronous messages. |
java.util.Date |
getObsoleteAfter()
Returns the date of the configured expire time of the OSCI message. |
eu.osci.ws._2008._05.transport.ReceptionReceiptDemandType |
getReceptionReceiptDemand()
Returns the set ReceptionReceiptDemand header element. |
java.util.List<org.w3._2005._08.addressing.RelatesToType> |
getRelatesTo()
Returns the set addressing 'RelatesTo' attribute. |
org.oasis_open.docs.ws_sx.ws_trust._200512.RequestSecurityTokenResponseCollectionType |
getRequestSecurityTokenResponseCollectionType()
Returns the OneTimeTokens for the receipts. |
eu.osci.ws._2008._05.transport.X509TokenContainerType |
getX509TokenContainer()
Returns the OSCI 'X509TokenContainer' including the certificates to check on the transfer way. |
OSCIResponse |
sendMessage(java.io.InputStream content)
Sends the configured OSCI message with the given stream. |
void |
setCompoundResult(java.util.List<org.w3._2002._03.xkms.CompoundResultType> _compoundResult)
Sets a List of XKMS check results on the OSCI message. |
void |
setDeliveryReceiptDemand()
Adds a DeliveryReceiptDemand OSCI header with default parameter to the OSCI message. |
void |
setDeliveryReceiptDemand(boolean echoRequest,
boolean qualifiedTSP,
java.lang.String eprURI)
Adds a DeliveryReceiptDemand OSCI header with the given parameter to the OSCI message. |
void |
setDeliveryReceiptDemand(eu.osci.ws._2008._05.transport.DeliveryReceiptDemandType _deliveryReceiptDemand)
Sets the given OSCI DeliveryReceiptDemand to make a request for a DeliveryReceipt. |
void |
setFetchedNotificationDemand(eu.osci.ws._2008._05.transport.FetchedNotificationDemandType _fetchedNotiDemand)
Sets the given OSCI FetchedNotificationDemand element as SOAP header. |
void |
setFetchedNotificationDemand(java.lang.String eprURI)
Adds a FetchedNotificationDemand OSCI header with the given parameter to the OSCI message. |
void |
setFetchedNotificationDemand(java.lang.String eprURI,
OSCIRequestAction businessScenario)
Adds a FetchedNotificationDemand OSCI header with the given parameter to the OSCI message. |
void |
setMsgTimeStamps(eu.osci.ws._2008._05.transport.MsgTimeStampsType _msgTime)
Sets the given MsgTimeStampsType object as part of the outgoing OSCI message. |
void |
setObsoleteAfter(java.util.Date expireDate)
Sets the date of the expire time of the OSCI message that will be send. |
void |
setReceptionReceiptDemand(boolean echoRequest,
boolean qualifiedTSP,
java.lang.String eprURI)
Adds a ReceptionReceiptDemand OSCI header with the given parameter to the OSCI message. |
void |
setReceptionReceiptDemand(eu.osci.ws._2008._05.transport.ReceptionReceiptDemandType _receptionReceiptDemand)
Better use the method setReceptionReceiptDemand(boolean, boolean, String) to set a
ReceptionReceiptDemand header. |
void |
setReplyTo(org.w3._2005._08.addressing.EndpointReferenceType _replyTo)
Sets the addressing 'ReplyTo' attribute on the OSCI message. |
void |
setRequestSecurityTokenResponseCollectionType(org.oasis_open.docs.ws_sx.ws_trust._200512.RequestSecurityTokenResponseCollectionType _rstrCol)
Sets the OneTimeTokens for the receipts. |
void |
setX509TokenContainer(eu.osci.ws._2008._05.transport.X509TokenContainerType _tokenContainer)
Sets the certificates that will be checked on the transfer way. |
Methods inherited from class eu.osci.messagetypes.OSCIRequestParent |
---|
getFaultTo, getFetchIteratorID, getFrom, getReplyTo, getTypeOfBusinessScenario, setFaultTo, setFrom, setTypeOfBusinessScenario |
Methods inherited from class eu.osci.messagetypes.OSCIMessage |
---|
getAction, getAdditionalHeaderList, getBindingProvider, getMessageId, getTo, setAction, setAdditionalHeaderList, setMessageId, setTo |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OSCIRequest(OSCIRequestParent parent)
OSCIMsgBoxFetchRequest
,
OSCIMsgBoxGetNextRequest
and then a OSCIMsgBoxCloseRequest
will be sent, then the
previous OSCI message could be given to this constructor because the configuration is the same.
parent
- Previous OSCI message in the same sequence.public OSCIRequest(EndpointLocator endpointLocator, javax.xml.ws.WebServiceFeature... _features)
endpointLocator
- The configured endpointLocator object._features
- To add other features for the endpoint (see Metro Api-Doc).public OSCIRequest(java.net.URL _wsdlURL, javax.xml.namespace.QName _serviceQName, javax.xml.namespace.QName _portQName, javax.xml.ws.WebServiceFeature... _features)
_wsdlURL
- The URL to the WSDL._serviceQName
- The service that will be used._portQName
- The port name that will be used_features
- To add other features for the endpoint (see Metro Api-Doc).Method Detail |
---|
public org.oasis_open.docs.ws_sx.ws_trust._200512.RequestSecurityTokenResponseCollectionType getRequestSecurityTokenResponseCollectionType()
public void setRequestSecurityTokenResponseCollectionType(org.oasis_open.docs.ws_sx.ws_trust._200512.RequestSecurityTokenResponseCollectionType _rstrCol)
_rstrCol
- The RSTRs for the OneTimeToken.public OSCIResponse sendMessage(java.io.InputStream content) throws javax.xml.bind.JAXBException, OSCIException
content
- The body stream to put into the SOAP message.
javax.xml.bind.JAXBException
- In the case of parsing or serialisation errors.
OSCIException
- In the case of OSCI SOAP faults.public void setReplyTo(org.w3._2005._08.addressing.EndpointReferenceType _replyTo)
_replyTo
- The 'ReplyTo' attribute.public java.util.List<org.w3._2005._08.addressing.RelatesToType> getRelatesTo()
public void addRelatesTo(org.w3._2005._08.addressing.RelatesToType _relatesTo)
_relatesTo
- The relatesTo attribute.public eu.osci.ws._2008._05.transport.X509TokenContainerType getX509TokenContainer()
public void setX509TokenContainer(eu.osci.ws._2008._05.transport.X509TokenContainerType _tokenContainer)
_tokenContainer
- The list of certificates that will be checked.public eu.osci.ws._2008._05.transport.ReceptionReceiptDemandType getReceptionReceiptDemand()
public void setReceptionReceiptDemand(eu.osci.ws._2008._05.transport.ReceptionReceiptDemandType _receptionReceiptDemand)
setReceptionReceiptDemand(boolean, boolean, String)
to set a
ReceptionReceiptDemand header.
_receptionReceiptDemand
- The preconfigured ReceptionReceiptDemand header.public eu.osci.ws._2008._05.transport.FetchedNotificationDemandType getFetchedNotificationDemand()
public void addCompoundResult(org.w3._2002._03.xkms.CompoundResultType compoundResultType)
compoundResultType
- The XKMS result of a certificate check.public java.util.List<org.w3._2002._03.xkms.CompoundResultType> getCompoundResult()
public void setCompoundResult(java.util.List<org.w3._2002._03.xkms.CompoundResultType> _compoundResult)
_compoundResult
- A List of XKMS results.public void setFetchedNotificationDemand(eu.osci.ws._2008._05.transport.FetchedNotificationDemandType _fetchedNotiDemand)
setFetchedNotificationDemand(String)
or
setFetchedNotificationDemand(String eprURI, OSCIRequestAction businessScenario)
to set a
FetchedNotificationDemand header.
_fetchedNotiDemand
- The FetchedNotificationDemand object.public eu.osci.ws._2008._05.transport.DeliveryReceiptDemandType getDeliveryReceiptDemand()
public void setDeliveryReceiptDemand(eu.osci.ws._2008._05.transport.DeliveryReceiptDemandType _deliveryReceiptDemand)
setDeliveryReceiptDemand(boolean, boolean, String)
or setDeliveryReceiptDemand()
to set
a DeliveryReceiptDemand header.
_deliveryReceiptDemand
- The DeliveryReceiptDemand.public void setReceptionReceiptDemand(boolean echoRequest, boolean qualifiedTSP, java.lang.String eprURI)
echoRequest
- If this value is true the whole OSCI message will be returned in the receipt.qualifiedTSP
- If this value is true the time stamp or the receipt will be qualified.eprURI
- The URI where the receipt will be received.public void setDeliveryReceiptDemand(boolean echoRequest, boolean qualifiedTSP, java.lang.String eprURI)
echoRequest
- If this value is true the whole OSCI message will be returned in the receipt.qualifiedTSP
- If this value is true the time stamp or the receipt will be qualified.eprURI
- The URI where the receipt will be received.public void setDeliveryReceiptDemand()
public void setFetchedNotificationDemand(java.lang.String eprURI)
eprURI
- URI for the FetchNotification to send to.public void setFetchedNotificationDemand(java.lang.String eprURI, OSCIRequestAction businessScenario)
eprURI
- URI for the FetchNotification to send to.businessScenario
- Type of businessScenario to use for the receipt.public java.util.Date getObsoleteAfter()
public void setObsoleteAfter(java.util.Date expireDate) throws javax.xml.datatype.DatatypeConfigurationException
expireDate
- The date to set the time when the message will expire.
javax.xml.datatype.DatatypeConfigurationException
- In the case of format exceptions.public eu.osci.ws._2008._05.transport.MsgTimeStampsType getMsgTimeStamps()
public void setMsgTimeStamps(eu.osci.ws._2008._05.transport.MsgTimeStampsType _msgTime)
_msgTime
- The configured object that will be set.public org.w3._2005._08.addressing.MetadataType getMetaData()
|
OSCI2-StarterKit |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |