com.ibm.websphere.http.headers
Interface HTTPControl
- public interface HTTPControl
The following features are supported:
-
URL
-
Version
-
Method
-
Dynamic Override URL
-
Dynamic Override Version
-
Dynamic Override Method
-
Media Type
-
Charset
-
Transfer Encoding
-
Content Encoding
-
Status Code
-
Reason Phrase
-
Content Length
-
Export Context Path
-
Authentication
-
SSL Settings
-
Proxy Settings
See Also:
HeadersPackage.getHTTPControl()
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getAuthentication()
Returns the value of the 'Authentication' containment reference.
|
|
|
getCharset()
Returns the value of the 'Charset' attribute.
|
|
getContentEncoding()
Returns the value of the 'Content Encoding' attribute.
|
|
getContentLength()
Returns the value of the 'HTTP Message Content Length' attribute.
|
|
getDynamicOverrideMethod()
Returns the value of the 'Dynamic Override HTTP Method' attribute.
|
|
getDynamicOverrideURL()
Returns the value of the 'Dynamic Override URL' attribute.
|
getDynamicOverrideVersion()
Returns the value of the 'Dynamic Override Version' attribute.
|
|
|
getExportContextPath()
Returns the value of the 'HTTP Export Request Context Path' attribute.
|
|
getMediaType()
Returns the value of the 'Media Type' attribute.
|
|
getMethod()
Returns the value of the 'HTTP Method' attribute.
|
|
getProxySettings()
Returns the value of the 'Proxy Settings' containment reference list.
|
|
getReasonPhrase()
Returns the value of the 'HTTP Response Reason Phrase' attribute.
|
getSSLSettings()
Returns the value of the 'SSL Settings' containment reference.
|
|
|
getStatusCode()
Returns the value of the 'HTTP Status Code' attribute.
|
|
getTransferEncoding()
Returns the value of the 'Transfer Encoding' attribute.
|
|
getURL()
Returns the value of the 'URL' attribute.
|
getVersion()
Returns the value of the 'Version' attribute.
|
|
|
isSetAuthentication()
Returns whether the value of the '
Authentication ' containment reference is set
|
|
isSetCharset()
Returns whether the value of the '
Charset ' attribute is set
|
|
isSetContentEncoding()
Returns whether the value of the '
Content Encoding ' attribute is set
|
|
isSetContentLength()
Returns whether the value of the '
Content Length ' attribute is set
|
|
isSetDynamicOverrideMethod()
Returns whether the value of the '
Dynamic Override Method ' attribute is set
|
|
isSetDynamicOverrideURL()
Returns whether the value of the '
Dynamic Override URL ' attribute is set
|
|
isSetDynamicOverrideVersion()
Returns whether the value of the '
Dynamic Override Version ' attribute is set
|
|
isSetExportContextPath()
Returns whether the value of the '
Export Context Path ' attribute is set
|
|
isSetMediaType()
Returns whether the value of the '
Media Type ' attribute is set
|
|
isSetMethod()
Returns whether the value of the '
Method ' attribute is set
|
|
isSetReasonPhrase()
Returns whether the value of the '
Reason Phrase ' attribute is set
|
|
isSetSSLSettings()
Returns whether the value of the '
SSL Settings ' containment reference is set
|
|
isSetStatusCode()
Returns whether the value of the '
Status Code ' attribute is set
|
|
isSetTransferEncoding()
Returns whether the value of the '
Transfer Encoding ' attribute is set
|
|
isSetURL()
Returns whether the value of the '
URL ' attribute is set
|
|
isSetVersion()
Returns whether the value of the '
Version ' attribute is set
|
|
setAuthentication(HTTPAuthentication value)
Sets the value of the '
Authentication ' containment reference
|
|
setCharset(java.lang.String value)
Sets the value of the '
Charset ' attribute
|
|
setContentEncoding(java.lang.String value)
Sets the value of the '
Content Encoding ' attribute
|
|
setContentLength(int value)
Sets the value of the '
Content Length ' attribute
|
|
setDynamicOverrideMethod(java.lang.String value)
Sets the value of the '
Dynamic Override Method ' attribute
|
|
setDynamicOverrideURL(java.lang.String value)
Sets the value of the '
Dynamic Override URL ' attribute
|
|
setDynamicOverrideVersion(HTTPVersion value)
Sets the value of the '
Dynamic Override Version ' attribute
|
|
setExportContextPath(java.lang.String value)
Sets the value of the '
Export Context Path ' attribute
|
|
setMediaType(java.lang.String value)
Sets the value of the '
Media Type ' attribute
|
|
setMethod(java.lang.String value)
Sets the value of the '
Method ' attribute
|
|
setReasonPhrase(java.lang.String value)
Sets the value of the '
Reason Phrase ' attribute
|
|
setSSLSettings(HTTPSSLSettings value)
Sets the value of the '
SSL Settings ' containment reference
|
|
setStatusCode(int value)
Sets the value of the '
Status Code ' attribute
|
|
setTransferEncoding(java.lang.String value)
Sets the value of the '
Transfer Encoding ' attribute
|
|
setURL(java.lang.String value)
Sets the value of the '
URL ' attribute
|
|
setVersion(HTTPVersion value)
Sets the value of the '
Version ' attribute
|
|
unsetAuthentication()
Unsets the value of the '
Authentication ' containment reference
|
|
unsetCharset()
Unsets the value of the '
Charset ' attribute
|
|
unsetContentEncoding()
Unsets the value of the '
Content Encoding ' attribute
|
|
unsetContentLength()
Unsets the value of the '
Content Length ' attribute
|
|
unsetDynamicOverrideMethod()
Unsets the value of the '
Dynamic Override Method ' attribute
|
|
unsetDynamicOverrideURL()
Unsets the value of the '
Dynamic Override URL ' attribute
|
|
unsetDynamicOverrideVersion()
Unsets the value of the '
Dynamic Override Version ' attribute
|
|
unsetExportContextPath()
Unsets the value of the '
Export Context Path ' attribute
|
|
unsetMediaType()
Unsets the value of the '
Media Type ' attribute
|
|
unsetMethod()
Unsets the value of the '
Method ' attribute
|
|
unsetReasonPhrase()
Unsets the value of the '
Reason Phrase ' attribute
|
|
unsetSSLSettings()
Unsets the value of the '
SSL Settings ' containment reference
|
|
unsetStatusCode()
Unsets the value of the '
Status Code ' attribute
|
|
unsetTransferEncoding()
Unsets the value of the '
Transfer Encoding ' attribute
|
|
unsetURL()
Unsets the value of the '
URL ' attribute
|
|
unsetVersion()
Unsets the value of the '
Version ' attribute
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
Method Detail
getURL
- java.lang.String getURL()
Returns the value of the 'URL' attribute.
Returns:
the value of the 'URL' attribute.
See Also:
setURL
- void setURL(java.lang.String value)
Sets the value of the '
URL
' attribute.
Parameters:
value
- the new value of the 'URL' attribute. See Also:
unsetURL
- void unsetURL()
Unsets the value of the '
URL
' attribute.
See Also:
isSetURL
- boolean isSetURL()
Returns whether the value of the '
URL
' attribute is set.
Returns:
whether the value of the 'URL' attribute is set.
See Also:
getVersion
- HTTPVersion getVersion()
Returns the value of the 'Version' attribute.
The default value is
"1.0"
.
Returns:
the value of the 'Version' attribute.
See Also:
setVersion
- void setVersion(HTTPVersion value)
Sets the value of the '
Version
' attribute.
Parameters:
value
- the new value of the 'Version' attribute. See Also:
unsetVersion
- void unsetVersion()
Unsets the value of the '
Version
' attribute.
See Also:
isSetVersion
- boolean isSetVersion()
Returns whether the value of the '
Version
' attribute is set.
Returns:
whether the value of the 'Version' attribute is set.
See Also:
getMethod
- java.lang.String getMethod()
Returns the value of the 'HTTP Method' attribute.
Returns:
the value of the 'HTTP Method' attribute.
See Also:
setMethod
- void setMethod(java.lang.String value)
Sets the value of the '
Method
' attribute.
Parameters:
value
- the new value of the 'Method' attribute. See Also:
unsetMethod
- void unsetMethod()
Unsets the value of the '
Method
' attribute.
See Also:
isSetMethod
- boolean isSetMethod()
Returns whether the value of the '
Method
' attribute is set.
Returns:
whether the value of the 'Method' attribute is set.
See Also:
getDynamicOverrideURL
- java.lang.String getDynamicOverrideURL( )
Returns the value of the 'Dynamic Override URL' attribute.
Returns:
the value of the 'Dynamic Override URL' attribute.
See Also:
isSetDynamicOverrideURL()
,
unsetDynamicOverrideURL()
,
setDynamicOverrideURL(String)
,
HeadersPackage.getHTTPControl_DynamicOverrideURL()
setDynamicOverrideURL
- void setDynamicOverrideURL(java.lang.String value)
Sets the value of the '
Dynamic Override URL
' attribute.
Parameters:
value
- the new value of the 'Dynamic Override URL' attribute. See Also:
unsetDynamicOverrideURL
- void unsetDynamicOverrideURL()
Unsets the value of the '
Dynamic Override URL
' attribute.
isSetDynamicOverrideURL
- boolean isSetDynamicOverrideURL( )
Returns whether the value of the '
Dynamic Override URL
' attribute is set.
Returns:
whether the value of the 'Dynamic Override URL' attribute is set.
See Also:
getDynamicOverrideVersion
- HTTPVersion getDynamicOverrideVersion( )
Returns the value of the 'Dynamic Override Version' attribute.
The default value is
"1.0"
.
Returns:
the value of the 'Dynamic Override Version' attribute.
See Also:
isSetDynamicOverrideVersion()
,
unsetDynamicOverrideVersion()
,
setDynamicOverrideVersion(HTTPVersion)
,
HeadersPackage.getHTTPControl_DynamicOverrideVersion()
setDynamicOverrideVersion
- void setDynamicOverrideVersion( HTTPVersion value)
Sets the value of the '
Dynamic Override Version
' attribute.
Parameters:
value
- the new value of the 'Dynamic Override Version' attribute. See Also:
unsetDynamicOverrideVersion
- void unsetDynamicOverrideVersion( )
Unsets the value of the '
Dynamic Override Version
' attribute.
See Also:
isSetDynamicOverrideVersion
- boolean isSetDynamicOverrideVersion( )
Returns whether the value of the '
Dynamic Override Version
' attribute is set.
Returns:
whether the value of the 'Dynamic Override Version' attribute is set.
See Also:
getDynamicOverrideMethod
- java.lang.String getDynamicOverrideMethod( )
Returns the value of the 'Dynamic Override HTTP Method' attribute.
Returns:
the value of the 'Dynamic Override HTTP Method' attribute.
See Also:
isSetDynamicOverrideMethod()
,
unsetDynamicOverrideMethod()
,
setDynamicOverrideMethod(String)
,
HeadersPackage.getHTTPControl_DynamicOverrideMethod()
setDynamicOverrideMethod
- void setDynamicOverrideMethod(java.lang.String value)
Sets the value of the '
Dynamic Override Method
' attribute.
Parameters:
value
- the new value of the 'Dynamic Override Method' attribute. See Also:
unsetDynamicOverrideMethod
- void unsetDynamicOverrideMethod( )
Unsets the value of the '
Dynamic Override Method
' attribute.
See Also:
isSetDynamicOverrideMethod
- boolean isSetDynamicOverrideMethod( )
Returns whether the value of the '
Dynamic Override Method
' attribute is set.
Returns:
whether the value of the 'Dynamic Override Method' attribute is set.
See Also:
getMediaType
- java.lang.String getMediaType()
Returns the value of the 'Media Type' attribute.
Returns:
the value of the 'Media Type' attribute.
See Also:
setMediaType
- void setMediaType(java.lang.String value)
Sets the value of the '
Media Type
' attribute.
Parameters:
value
- the new value of the 'Media Type' attribute. See Also:
unsetMediaType
- void unsetMediaType()
Unsets the value of the '
Media Type
' attribute.
See Also:
isSetMediaType
- boolean isSetMediaType()
Returns whether the value of the '
Media Type
' attribute is set.
Returns:
whether the value of the 'Media Type' attribute is set.
See Also:
getCharset
- java.lang.String getCharset()
Returns the value of the 'Charset' attribute.
Returns:
the value of the 'Charset' attribute.
See Also:
setCharset
- void setCharset(java.lang.String value)
Sets the value of the '
Charset
' attribute.
Parameters:
value
- the new value of the 'Charset' attribute. See Also:
unsetCharset
- void unsetCharset()
Unsets the value of the '
Charset
' attribute.
See Also:
isSetCharset
- boolean isSetCharset()
Returns whether the value of the '
Charset
' attribute is set.
Returns:
whether the value of the 'Charset' attribute is set.
See Also:
getTransferEncoding
- java.lang.String getTransferEncoding( )
Returns the value of the 'Transfer Encoding' attribute.
Returns:
the value of the 'Transfer Encoding' attribute.
See Also:
isSetTransferEncoding()
,
unsetTransferEncoding()
,
setTransferEncoding(String)
,
HeadersPackage.getHTTPControl_TransferEncoding()
setTransferEncoding
- void setTransferEncoding(java.lang.String value)
Sets the value of the '
Transfer Encoding
' attribute.
Parameters:
value
- the new value of the 'Transfer Encoding' attribute. See Also:
unsetTransferEncoding
- void unsetTransferEncoding()
Unsets the value of the '
Transfer Encoding
' attribute.
isSetTransferEncoding
- boolean isSetTransferEncoding()
Returns whether the value of the '
Transfer Encoding
' attribute is set.
Returns:
whether the value of the 'Transfer Encoding' attribute is set.
See Also:
getContentEncoding
- java.lang.String getContentEncoding( )
Returns the value of the 'Content Encoding' attribute.
Returns:
the value of the 'Content Encoding' attribute.
See Also:
isSetContentEncoding()
,
unsetContentEncoding()
,
setContentEncoding(String)
,
HeadersPackage.getHTTPControl_ContentEncoding()
setContentEncoding
- void setContentEncoding(java.lang.String value)
Sets the value of the '
Content Encoding
' attribute.
Parameters:
value
- the new value of the 'Content Encoding' attribute. See Also:
unsetContentEncoding
- void unsetContentEncoding()
Unsets the value of the '
Content Encoding
' attribute.
isSetContentEncoding
- boolean isSetContentEncoding()
Returns whether the value of the '
Content Encoding
' attribute is set.
Returns:
whether the value of the 'Content Encoding' attribute is set.
See Also:
getStatusCode
- int getStatusCode()
Returns the value of the 'HTTP Status Code' attribute.
Returns:
the value of the 'Status Code' attribute.
See Also:
isSetStatusCode()
,
unsetStatusCode()
,
setStatusCode(int)
,
HeadersPackage.getHTTPControl_StatusCode()
setStatusCode
- void setStatusCode(int value)
Sets the value of the '
Status Code
' attribute.
Parameters:
value
- the new value of the 'Status Code' attribute. See Also:
unsetStatusCode
- void unsetStatusCode()
Unsets the value of the '
Status Code
' attribute.
See Also:
isSetStatusCode
- boolean isSetStatusCode()
Returns whether the value of the '
Status Code
' attribute is set.
Returns:
whether the value of the 'Status Code' attribute is set.
See Also:
getReasonPhrase
- java.lang.String getReasonPhrase( )
Returns the value of the 'HTTP Response Reason Phrase' attribute.
Returns:
the value of the 'Reason Phrase' attribute.
See Also:
isSetReasonPhrase()
,
unsetReasonPhrase()
,
setReasonPhrase(String)
,
HeadersPackage.getHTTPControl_ReasonPhrase()
setReasonPhrase
- void setReasonPhrase(java.lang.String value)
Sets the value of the '
Reason Phrase
' attribute.
Parameters:
value
- the new value of the 'Reason Phrase' attribute. See Also:
unsetReasonPhrase
- void unsetReasonPhrase()
Unsets the value of the '
Reason Phrase
' attribute.
isSetReasonPhrase
- boolean isSetReasonPhrase()
Returns whether the value of the '
Reason Phrase
' attribute is set.
Returns:
whether the value of the 'Reason Phrase' attribute is set.
See Also:
getContentLength
- int getContentLength()
Returns the value of the 'HTTP Message Content Length' attribute.
Returns:
the value of the 'HTTP Message Content Length' attribute.
See Also:
isSetContentLength()
,
unsetContentLength()
,
setContentLength(int)
,
HeadersPackage.getHTTPControl_ContentLength()
setContentLength
- void setContentLength(int value)
Sets the value of the '
Content Length
' attribute.
Parameters:
value
- the new value of the 'Content Length' attribute. See Also:
unsetContentLength
- void unsetContentLength()
Unsets the value of the '
Content Length
' attribute.
isSetContentLength
- boolean isSetContentLength()
Returns whether the value of the '
Content Length
' attribute is set.
Returns:
whether the value of the 'Content Length' attribute is set.
See Also:
getExportContextPath
- java.lang.String getExportContextPath( )
Returns the value of the 'HTTP Export Request Context Path' attribute.
Returns:
the value of the 'HTTP Export Request Context Path' attribute.
See Also:
isSetExportContextPath()
,
unsetExportContextPath()
,
setExportContextPath(String)
,
HeadersPackage.getHTTPControl_ExportContextPath()
setExportContextPath
- void setExportContextPath(java.lang.String value)
Sets the value of the '
Export Context Path
' attribute.
Parameters:
value
- the new value of the 'Export Context Path' attribute. See Also:
unsetExportContextPath
- void unsetExportContextPath()
Unsets the value of the '
Export Context Path
' attribute.
isSetExportContextPath
- boolean isSetExportContextPath( )
Returns whether the value of the '
Export Context Path
' attribute is set.
Returns:
whether the value of the 'Export Context Path' attribute is set.
See Also:
getAuthentication
- HTTPAuthentication getAuthentication( )
Returns the value of the 'Authentication' containment reference.
Returns:
the value of the 'Authentication' containment reference.
See Also:
isSetAuthentication()
,
unsetAuthentication()
,
setAuthentication(HTTPAuthentication)
,
HeadersPackage.getHTTPControl_Authentication()
setAuthentication
- void setAuthentication(HTTPAuthentication value)
Sets the value of the '
Authentication
' containment reference.
Parameters:
value
- the new value of the 'Authentication' containment reference. See Also:
unsetAuthentication
- void unsetAuthentication()
Unsets the value of the '
Authentication
' containment reference.
isSetAuthentication
- boolean isSetAuthentication()
Returns whether the value of the '
Authentication
' containment reference is set.
Returns:
whether the value of the 'Authentication' containment reference is set.
See Also:
getSSLSettings
- HTTPSSLSettings getSSLSettings( )
Returns the value of the 'SSL Settings' containment reference.
Returns:
the value of the 'SSL Settings' containment reference.
See Also:
isSetSSLSettings()
,
unsetSSLSettings()
,
setSSLSettings(HTTPSSLSettings)
,
HeadersPackage.getHTTPControl_SSLSettings()
setSSLSettings
- void setSSLSettings(HTTPSSLSettings value)
Sets the value of the '
SSL Settings
' containment reference.
Parameters:
value
- the new value of the 'SSL Settings' containment reference. See Also:
unsetSSLSettings
- void unsetSSLSettings()
Unsets the value of the '
SSL Settings
' containment reference.
isSetSSLSettings
- boolean isSetSSLSettings()
Returns whether the value of the '
SSL Settings
' containment reference is set.
Returns:
whether the value of the 'SSL Settings' containment reference is set.
See Also:
getProxySettings
- java.util.List getProxySettings( )
Returns the value of the 'Proxy Settings' containment reference list.
The list contents are of type
HTTPProxySettings
.
Returns:
the value of the 'Proxy Settings' containment reference list.
See Also:
HeadersPackage.getHTTPControl_ProxySettings()