Inheritance diagram for org.cybergarage.upnp.control.ControlRequest:

Public Member Functions
	ControlRequest ()

	ControlRequest (HTTPRequest httpReq)

boolean	isQueryControl ()

boolean	isActionControl ()

Public Member Functions inherited from org.cybergarage.soap.SOAPRequest
	SOAPRequest ()

	SOAPRequest (HTTPRequest httpReq)

void	setSOAPAction (String action)

String	getSOAPAction ()

boolean	isSOAPAction (String value)

SOAPResponse	postMessage (String host, int port)

void	setEnvelopeNode (Node node)

Node	getEnvelopeNode ()

Node	getBodyNode ()

void	setContent (Node node)

void	print ()

Public Member Functions inherited from org.cybergarage.http.HTTPRequest
	HTTPRequest ()

	HTTPRequest (InputStream in)

	HTTPRequest (HTTPSocket httpSock)

void	setMethod (String value)

String	getMethod ()

boolean	isMethod (String method)

boolean	isGetRequest ()

boolean	isPostRequest ()

boolean	isHeadRequest ()

boolean	isSubscribeRequest ()

boolean	isUnsubscribeRequest ()

boolean	isNotifyRequest ()

void	setURI (String value, boolean isCheckRelativeURL)

void	setURI (String value)

String	getURI ()

ParameterList	getParameterList ()

String	getParameterValue (String name)

boolean	isSOAPAction ()

void	setRequestHost (String host)

String	getRequestHost ()

void	setRequestPort (int host)

int	getRequestPort ()

void	setSocket (HTTPSocket value)

HTTPSocket	getSocket ()

String	getLocalAddress ()

int	getLocalPort ()

boolean	parseRequestLine (String lineStr)

String	getHTTPVersion ()

String	getFirstLineString ()

String	getHeader ()

boolean	isKeepAlive ()

boolean	read ()

boolean	post (HTTPResponse httpRes)

HTTPResponse	post (String host, int port, boolean isKeepAlive)

HTTPResponse	post (String host, int port)

void	set (HTTPRequest httpReq)

boolean	returnResponse (int statusCode)

boolean	returnOK ()

boolean	returnBadRequest ()

String	toString ()

Public Member Functions inherited from org.cybergarage.http.HTTPPacket
	HTTPPacket ()

	HTTPPacket (HTTPPacket httpPacket)

	HTTPPacket (InputStream in)

void	init ()

void	setVersion (String ver)

String	getVersion ()

boolean	read (HTTPSocket httpSock)

boolean	hasFirstLine ()

int	getNHeaders ()

void	addHeader (HTTPHeader header)

void	addHeader (String name, String value)

HTTPHeader	getHeader (int n)

HTTPHeader	getHeader (String name)

void	clearHeaders ()

boolean	hasHeader (String name)

void	setHeader (String name, String value)

void	setHeader (String name, int value)

void	setHeader (String name, long value)

void	setHeader (HTTPHeader header)

String	getHeaderValue (String name)

void	setStringHeader (String name, String value, String startWidth, String endWidth)

void	setStringHeader (String name, String value)

String	getStringHeaderValue (String name, String startWidth, String endWidth)

String	getStringHeaderValue (String name)

void	setIntegerHeader (String name, int value)

void	setLongHeader (String name, long value)

int	getIntegerHeaderValue (String name)

long	getLongHeaderValue (String name)

String	getHeaderString ()

void	setContent (byte data[], boolean updateWithContentLength)

void	setContent (byte data[])

void	setContent (String data, boolean updateWithContentLength)

void	setContent (String data)

byte[]	getContent ()

String	getContentString ()

boolean	hasContent ()

void	setContentInputStream (InputStream in)

InputStream	getContentInputStream ()

boolean	hasContentInputStream ()

void	setContentType (String type)

String	getContentType ()

void	setContentLanguage (String code)

String	getContentLanguage ()

String	getCharSet ()

void	setContentLength (long len)

long	getContentLength ()

boolean	hasConnection ()

void	setConnection (String value)

String	getConnection ()

boolean	isCloseConnection ()

boolean	isKeepAliveConnection ()

boolean	hasContentRange ()

void	setContentRange (long firstPos, long lastPos, long length)

long[]	getContentRange ()

long	getContentRangeFirstPosition ()

long	getContentRangeLastPosition ()

long	getContentRangeInstanceLength ()

void	setCacheControl (String directive)

void	setCacheControl (String directive, int value)

void	setCacheControl (int value)

String	getCacheControl ()

void	setServer (String name)

String	getServer ()

void	setHost (String host, int port)

void	setHost (String host)

String	getHost ()

void	setDate (Calendar cal)

String	getDate ()

boolean	hasTransferEncoding ()

void	setTransferEncoding (String value)

String	getTransferEncoding ()

boolean	isChunked ()

Protected Member Functions
void	setRequestHost (Service service)

Protected Member Functions inherited from org.cybergarage.http.HTTPPacket
boolean	set (InputStream in, boolean onlyHeaders)

boolean	set (InputStream in)

boolean	set (HTTPSocket httpSock)

void	set (HTTPPacket httpPacket)

String	getFirstLine ()

String	getFirstLineToken (int num)

Detailed Description

Base class for UPnP control requests.

This class extends SOAPRequest to provide common functionality for both action requests and state variable query requests. It handles URL resolution, including absolute and relative URLs, URL base paths, and port extraction.

See also: ActionRequest; QueryRequest; SOAPRequest

Constructor & Destructor Documentation

◆ ControlRequest() [1/2]

org.cybergarage.upnp.control.ControlRequest.ControlRequest ( )

inline

Constructs an empty control request.

◆ ControlRequest() [2/2]

org.cybergarage.upnp.control.ControlRequest.ControlRequest ( HTTPRequest httpReq )

inline

Constructs a control request from an HTTP request.

Parameters

httpReq the HTTP request to wrap

Member Function Documentation

◆ isActionControl()

boolean org.cybergarage.upnp.control.ControlRequest.isActionControl ( )

inline

Checks if this is an action control request.

Returns: true if this is an action invocation request, false if it's a query request

◆ isQueryControl()

boolean org.cybergarage.upnp.control.ControlRequest.isQueryControl ( )

inline

Checks if this is a state variable query request.

Returns: true if this is a QueryStateVariable request, false otherwise

◆ setRequestHost()

void org.cybergarage.upnp.control.ControlRequest.setRequestHost ( Service service )

inlineprotected

Sets the request host and port from the service's control URL.

This method resolves the control URL, considering:

Absolute vs relative URLs
URL base paths from the device description
Port numbers in control URLs
Fallback to device location if URLBase is not set

Parameters

service the service whose control URL to use

The documentation for this class was generated from the following file:

core/src/main/java/org/cybergarage/upnp/control/ControlRequest.java

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ControlRequest() [1/2]

◆ ControlRequest() [2/2]

Member Function Documentation

◆ isActionControl()

◆ isQueryControl()

◆ setRequestHost()