| java.lang.Object
 uk.org.ponder.webapputil.ConsumerInfo
| ConsumerInfo | | public class ConsumerInfo (Code) | | Request information stored about a consumer of this service. NB - some
fields will vary per-request.
author:
Antranig Basman (antranig@caret.cam.ac.uk) |
| Field Summary | |
| public String | consumerid
| | public String | consumername
| | public String | consumertype
A string identifying the type of consumer. | | public String | externalURL
The URL to be issued by a user out in the wild to navigate the hosting
environment to the point where the tool instance corresponding to this
resource is visible. | | public String | extraparameters
Any other parameters required, together with urlbase, to render a
correct consumer-side URL. | | public String | informationbase
| | public String | resourceurlbase
The URL base required
for statically served resource URLs written to a remote consumer
during this request cycle. | | public String | urlbase
The URL base required
for URLs holding dynamic content written to a remote consumer during
this request cycle. |
| Method Summary | |
| public ConsumerInfo | get()
A method useful to breach proxy boundaries. |
| consumertype | | public String consumertype(Code) | | A string identifying the type of consumer. Supported currently are
"coursework" and "sakai". If this field is left null, it is assumed there
is no consumer.
|
| externalURL | | public String externalURL(Code) | | The URL to be issued by a user out in the wild to navigate the hosting
environment to the point where the tool instance corresponding to this
resource is visible. If this is null, the tool URL itself is presumed
to be valid (as per Coursework). This URL may be incomplete/invalid in
various ways, as a result of a "private arrangement" between the forwarder
and the UltimateURLRenderer in use.
|
| extraparameters | | public String extraparameters(Code) | | Any other parameters required, together with urlbase, to render a
correct consumer-side URL. This begins with an ampersand and
consists of fully-encoded parameter pairs ready to be postpended
to a parameter string.
|
| informationbase | | public String informationbase(Code) | | The FULL URL for requests made to the consumer's Information Servlet
|
| resourceurlbase | | public String resourceurlbase(Code) | | The URL base required
for statically served resource URLs written to a remote consumer
during this request cycle. Note that this may not refer to the same
webapp or machine as the URL base above. We don't expect requests
for these URLs to pass through the dispatch of the remote consumer,
but be resolved directly.
|
| urlbase | | public String urlbase(Code) | | The URL base required
for URLs holding dynamic content written to a remote consumer during
this request cycle. This URL includes a trailing slash.
|
| get | | public ConsumerInfo get()(Code) | | A method useful to breach proxy boundaries. Call if using this object
from an application-scope bean.
|
|
|