|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.xcap.base.BaseXcapRequest
public abstract class BaseXcapRequest
XcapClientRequest is constructed to send an XCAP request to an XDMS. The XcapClientRequest supports digest authentication. If the password is empty then it will try to send an asserted identity in the headers. The default asserted identity header that is used is X-Xcap-Asserted-Identity. If another header should be used, call the setDefaultIdentityHeader(String) method.
Field Summary | |
---|---|
protected java.lang.String |
auid
|
static java.lang.String |
CLASSNAME
Classname |
protected DocumentSelector |
documentSelector
|
protected java.lang.String |
httpMethod
|
static java.util.logging.Logger |
LOGGER
Logger for this class |
protected NodeSelector |
nodeSelector
|
protected static java.util.ResourceBundle |
rb
|
protected java.lang.String |
xcapRoot
|
protected java.net.URL |
xcapURI
|
protected java.lang.String |
xml
|
protected java.lang.String |
xmlName
|
protected java.lang.String |
xui
|
Constructor Summary | |
---|---|
BaseXcapRequest(java.lang.String httpMethod,
java.lang.String xcapRoot,
java.lang.String auid,
java.lang.String xui,
java.lang.String xmlName,
java.lang.String nodeSelector,
java.lang.String xml)
Constructs the XcapClientRequest. |
|
BaseXcapRequest(java.lang.String httpMethod,
java.net.URL xcapURI,
java.lang.String xml)
Constructs the XcapClientRequest. |
Method Summary | |
---|---|
java.lang.String |
getAuid()
Returns the AUID. |
java.lang.String |
getContentType()
Returns the Content-Type. |
DocumentSelector |
getDocumentSelector()
Returns the document selector for this XCAP URI |
java.lang.String |
getHttpMethod()
Returns the HTTP METHOD. |
NodeSelector |
getNodeSelector()
Returns the nodeSelector. |
java.lang.String |
getXcapRoot()
Returns the XCAP Root. |
java.net.URL |
getXcapURI()
Returns the XCAP URI of the request. |
java.lang.String |
getXml()
Returns the xml. |
java.lang.String |
getXmlName()
Returns the xmlName. |
java.lang.String |
getXui()
Returns the XUI. |
boolean |
isGlobalDocument()
Returns whether the document is global or not. |
void |
setHttpMethod(java.lang.String httpMethod)
Sets the HTTP METHOD. |
void |
setXcapURI(java.lang.String xcapURI)
Sets the full XCAP URI used to send the XCAP request. |
void |
setXcapURI(java.net.URL xcapURI)
Sets the full XCAP URI used to send the XCAP request. |
void |
setXml(java.lang.String xml)
Sets the xml. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.xcap.XcapRequest |
---|
getHeader, getHeaderNames, getHeaders |
Field Detail |
---|
public static final java.lang.String CLASSNAME
public static final java.util.logging.Logger LOGGER
protected static final java.util.ResourceBundle rb
protected java.lang.String httpMethod
protected java.lang.String xcapRoot
protected java.lang.String auid
protected java.lang.String xui
protected java.lang.String xmlName
protected NodeSelector nodeSelector
protected DocumentSelector documentSelector
protected java.lang.String xml
protected java.net.URL xcapURI
Constructor Detail |
---|
public BaseXcapRequest(java.lang.String httpMethod, java.net.URL xcapURI, java.lang.String xml) throws java.net.MalformedURLException
httpMethod
- The HTTP METHOD type.xcapURI
- The full XCAP URI of the form
http(s)://hostname:hostport/contextRoot/AUID/xcapDocSelector/~~/xcapNodeSelectorxml
- The XML document if sending a PUT or POST.
java.net.MalformedURLException
XcapConstants.HTTP_METHOD_GET
,
XcapConstants.HTTP_METHOD_PUT
,
XcapConstants.HTTP_METHOD_DELETE
public BaseXcapRequest(java.lang.String httpMethod, java.lang.String xcapRoot, java.lang.String auid, java.lang.String xui, java.lang.String xmlName, java.lang.String nodeSelector, java.lang.String xml) throws java.net.MalformedURLException
httpMethod
- The HTTP METHOD type.xcapRoot
- The xcap root of the form
http(s)://hostname:hostport/contextRootauid
- The AUID of the XCAP URI.xui
- The XML User Identifier. If not specified, then assumes a
GLOBAL document.xmlName
- The name used to identify the XML document.nodeSelector
- The nodeSelector that does NOT include the ~~
separator.xml
- The XML document if sending a PUT or POST.
java.net.MalformedURLException
XcapConstants.HTTP_METHOD_GET
,
XcapConstants.HTTP_METHOD_PUT
,
XcapConstants.HTTP_METHOD_DELETE
Method Detail |
---|
public java.net.URL getXcapURI()
getXcapURI
in interface XcapRequest
public java.lang.String getXcapRoot()
getXcapRoot
in interface XcapRequest
public java.lang.String getAuid()
getAuid
in interface XcapRequest
public java.lang.String getContentType()
getContentType
in interface XcapRequest
public boolean isGlobalDocument()
isGlobalDocument
in interface XcapRequest
public java.lang.String getXui()
getXui
in interface XcapRequest
public java.lang.String getXmlName()
getXmlName
in interface XcapRequest
public NodeSelector getNodeSelector()
getNodeSelector
in interface XcapRequest
public java.lang.String getXml()
getXml
in interface XcapRequest
public void setXml(java.lang.String xml)
xml
- The xml to setpublic java.lang.String getHttpMethod()
public void setHttpMethod(java.lang.String httpMethod)
public void setXcapURI(java.net.URL xcapURI) throws java.net.MalformedURLException
xcapURI
- The full XCAP URI used to send the XCAP request.
java.net.MalformedURLException
public void setXcapURI(java.lang.String xcapURI) throws java.net.MalformedURLException
xcapURI
- The full XCAP URI used to send the XCAP request.
java.net.MalformedURLException
public DocumentSelector getDocumentSelector()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |