com.ibm.websphere.http.headers

Interface HTTPControl


  1. public interface HTTPControl
A representation of the model object 'HTTP Control'.

The following features are supported:

See Also:
HeadersPackage.getHTTPControl()

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. HTTPAuthentication
getAuthentication()
Returns the value of the 'Authentication' containment reference.
  1. java.lang.String
getCharset()
Returns the value of the 'Charset' attribute.
  1. java.lang.String
getContentEncoding()
Returns the value of the 'Content Encoding' attribute.
  1. int
getContentLength()
Returns the value of the 'HTTP Message Content Length' attribute.
  1. java.lang.String
getDynamicOverrideMethod()
Returns the value of the 'Dynamic Override HTTP Method' attribute.
  1. java.lang.String
getDynamicOverrideURL()
Returns the value of the 'Dynamic Override URL' attribute.
  1. HTTPVersion
getDynamicOverrideVersion()
Returns the value of the 'Dynamic Override Version' attribute.
  1. java.lang.String
getExportContextPath()
Returns the value of the 'HTTP Export Request Context Path' attribute.
  1. java.lang.String
getMediaType()
Returns the value of the 'Media Type' attribute.
  1. java.lang.String
getMethod()
Returns the value of the 'HTTP Method' attribute.
  1. java.util.List
getProxySettings()
Returns the value of the 'Proxy Settings' containment reference list.
  1. java.lang.String
getReasonPhrase()
Returns the value of the 'HTTP Response Reason Phrase' attribute.
  1. HTTPSSLSettings
getSSLSettings()
Returns the value of the 'SSL Settings' containment reference.
  1. int
getStatusCode()
Returns the value of the 'HTTP Status Code' attribute.
  1. java.lang.String
getTransferEncoding()
Returns the value of the 'Transfer Encoding' attribute.
  1. java.lang.String
getURL()
Returns the value of the 'URL' attribute.
  1. HTTPVersion
getVersion()
Returns the value of the 'Version' attribute.
  1. boolean
isSetAuthentication()
Returns whether the value of the ' Authentication' containment reference is set
  1. boolean
isSetCharset()
Returns whether the value of the ' Charset' attribute is set
  1. boolean
isSetContentEncoding()
Returns whether the value of the ' Content Encoding' attribute is set
  1. boolean
isSetContentLength()
Returns whether the value of the ' Content Length' attribute is set
  1. boolean
isSetDynamicOverrideMethod()
Returns whether the value of the ' Dynamic Override Method' attribute is set
  1. boolean
isSetDynamicOverrideURL()
Returns whether the value of the ' Dynamic Override URL' attribute is set
  1. boolean
isSetDynamicOverrideVersion()
Returns whether the value of the ' Dynamic Override Version' attribute is set
  1. boolean
isSetExportContextPath()
Returns whether the value of the ' Export Context Path' attribute is set
  1. boolean
isSetMediaType()
Returns whether the value of the ' Media Type' attribute is set
  1. boolean
isSetMethod()
Returns whether the value of the ' Method' attribute is set
  1. boolean
isSetReasonPhrase()
Returns whether the value of the ' Reason Phrase' attribute is set
  1. boolean
isSetSSLSettings()
Returns whether the value of the ' SSL Settings' containment reference is set
  1. boolean
isSetStatusCode()
Returns whether the value of the ' Status Code' attribute is set
  1. boolean
isSetTransferEncoding()
Returns whether the value of the ' Transfer Encoding' attribute is set
  1. boolean
isSetURL()
Returns whether the value of the ' URL' attribute is set
  1. boolean
isSetVersion()
Returns whether the value of the ' Version' attribute is set
  1. void
setAuthentication(HTTPAuthentication value)
Sets the value of the ' Authentication' containment reference
  1. void
setCharset(java.lang.String value)
Sets the value of the ' Charset' attribute
  1. void
setContentEncoding(java.lang.String value)
Sets the value of the ' Content Encoding' attribute
  1. void
setContentLength(int value)
Sets the value of the ' Content Length' attribute
  1. void
setDynamicOverrideMethod(java.lang.String value)
Sets the value of the ' Dynamic Override Method' attribute
  1. void
setDynamicOverrideURL(java.lang.String value)
Sets the value of the ' Dynamic Override URL' attribute
  1. void
setDynamicOverrideVersion(HTTPVersion value)
Sets the value of the ' Dynamic Override Version' attribute
  1. void
setExportContextPath(java.lang.String value)
Sets the value of the ' Export Context Path' attribute
  1. void
setMediaType(java.lang.String value)
Sets the value of the ' Media Type' attribute
  1. void
setMethod(java.lang.String value)
Sets the value of the ' Method' attribute
  1. void
setReasonPhrase(java.lang.String value)
Sets the value of the ' Reason Phrase' attribute
  1. void
setSSLSettings(HTTPSSLSettings value)
Sets the value of the ' SSL Settings' containment reference
  1. void
setStatusCode(int value)
Sets the value of the ' Status Code' attribute
  1. void
setTransferEncoding(java.lang.String value)
Sets the value of the ' Transfer Encoding' attribute
  1. void
setURL(java.lang.String value)
Sets the value of the ' URL' attribute
  1. void
setVersion(HTTPVersion value)
Sets the value of the ' Version' attribute
  1. void
unsetAuthentication()
Unsets the value of the ' Authentication' containment reference
  1. void
unsetCharset()
Unsets the value of the ' Charset' attribute
  1. void
unsetContentEncoding()
Unsets the value of the ' Content Encoding' attribute
  1. void
unsetContentLength()
Unsets the value of the ' Content Length' attribute
  1. void
unsetDynamicOverrideMethod()
Unsets the value of the ' Dynamic Override Method' attribute
  1. void
unsetDynamicOverrideURL()
Unsets the value of the ' Dynamic Override URL' attribute
  1. void
unsetDynamicOverrideVersion()
Unsets the value of the ' Dynamic Override Version' attribute
  1. void
unsetExportContextPath()
Unsets the value of the ' Export Context Path' attribute
  1. void
unsetMediaType()
Unsets the value of the ' Media Type' attribute
  1. void
unsetMethod()
Unsets the value of the ' Method' attribute
  1. void
unsetReasonPhrase()
Unsets the value of the ' Reason Phrase' attribute
  1. void
unsetSSLSettings()
Unsets the value of the ' SSL Settings' containment reference
  1. void
unsetStatusCode()
Unsets the value of the ' Status Code' attribute
  1. void
unsetTransferEncoding()
Unsets the value of the ' Transfer Encoding' attribute
  1. void
unsetURL()
Unsets the value of the ' URL' attribute
  1. void
unsetVersion()
Unsets the value of the ' Version' attribute

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

getURL

  1. java.lang.String getURL()
Returns the value of the 'URL' attribute.
Returns:
the value of the 'URL' attribute.
See Also:
isSetURL(), unsetURL(), setURL(String), HeadersPackage.getHTTPControl_URL()

setURL

  1. 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

  1. void unsetURL()
Unsets the value of the ' URL' attribute.
See Also:

isSetURL

  1. 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

  1. HTTPVersion getVersion()
Returns the value of the 'Version' attribute. The default value is "1.0".
Returns:
the value of the 'Version' attribute.
See Also:
isSetVersion(), unsetVersion(), setVersion(HTTPVersion), HeadersPackage.getHTTPControl_Version()

setVersion

  1. void setVersion(HTTPVersion value)
Sets the value of the ' Version' attribute.
Parameters:
value - the new value of the 'Version' attribute.
See Also:

unsetVersion

  1. void unsetVersion()
Unsets the value of the ' Version' attribute.
See Also:

isSetVersion

  1. 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

  1. java.lang.String getMethod()
Returns the value of the 'HTTP Method' attribute.
Returns:
the value of the 'HTTP Method' attribute.
See Also:
isSetMethod(), unsetMethod(), setMethod(String), HeadersPackage.getHTTPControl_Method()

setMethod

  1. 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

  1. void unsetMethod()
Unsets the value of the ' Method' attribute.
See Also:

isSetMethod

  1. 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

  1. 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

  1. 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

  1. void unsetDynamicOverrideURL()
Unsets the value of the ' Dynamic Override URL' attribute.
See Also:

isSetDynamicOverrideURL

  1. 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

  1. 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:

setDynamicOverrideVersion

  1. 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

  1. void unsetDynamicOverrideVersion( )
Unsets the value of the ' Dynamic Override Version' attribute.
See Also:

isSetDynamicOverrideVersion

  1. 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

  1. 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

  1. 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

  1. void unsetDynamicOverrideMethod( )
Unsets the value of the ' Dynamic Override Method' attribute.
See Also:

isSetDynamicOverrideMethod

  1. 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

  1. java.lang.String getMediaType()
Returns the value of the 'Media Type' attribute.
Returns:
the value of the 'Media Type' attribute.
See Also:
isSetMediaType(), unsetMediaType(), setMediaType(String), HeadersPackage.getHTTPControl_MediaType()

setMediaType

  1. 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

  1. void unsetMediaType()
Unsets the value of the ' Media Type' attribute.
See Also:

isSetMediaType

  1. 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

  1. java.lang.String getCharset()
Returns the value of the 'Charset' attribute.
Returns:
the value of the 'Charset' attribute.
See Also:
isSetCharset(), unsetCharset(), setCharset(String), HeadersPackage.getHTTPControl_Charset()

setCharset

  1. 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

  1. void unsetCharset()
Unsets the value of the ' Charset' attribute.
See Also:

isSetCharset

  1. 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

  1. 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

  1. 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

  1. void unsetTransferEncoding()
Unsets the value of the ' Transfer Encoding' attribute.
See Also:

isSetTransferEncoding

  1. 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

  1. 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

  1. 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

  1. void unsetContentEncoding()
Unsets the value of the ' Content Encoding' attribute.
See Also:

isSetContentEncoding

  1. 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

  1. 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

  1. 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

  1. void unsetStatusCode()
Unsets the value of the ' Status Code' attribute.
See Also:

isSetStatusCode

  1. 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

  1. 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

  1. 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

  1. void unsetReasonPhrase()
Unsets the value of the ' Reason Phrase' attribute.
See Also:

isSetReasonPhrase

  1. 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

  1. 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

  1. 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

  1. void unsetContentLength()
Unsets the value of the ' Content Length' attribute.
See Also:

isSetContentLength

  1. 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

  1. 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

  1. 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

  1. void unsetExportContextPath()
Unsets the value of the ' Export Context Path' attribute.
See Also:

isSetExportContextPath

  1. 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

  1. HTTPAuthentication getAuthentication( )
Returns the value of the 'Authentication' containment reference.
Returns:
the value of the 'Authentication' containment reference.
See Also:

setAuthentication

  1. 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

  1. void unsetAuthentication()
Unsets the value of the ' Authentication' containment reference.
See Also:

isSetAuthentication

  1. 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

  1. 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

  1. 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

  1. void unsetSSLSettings()
Unsets the value of the ' SSL Settings' containment reference.
See Also:

isSetSSLSettings

  1. 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

  1. 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()