public class MessageContext extends Object
Modifier and Type | Class and Description |
---|---|
class |
MessageContext.BasicPrincipal
Minimal implementation of the
Principal
interface. |
Constructor and Description |
---|
MessageContext()
Creates a new JSON-RPC 2.0 request / notification context.
|
MessageContext(javax.servlet.http.HttpServletRequest httpRequest)
Creates a new JSON-RPC 2.0 request / notification context from the
specified HTTP request.
|
MessageContext(String clientHostName,
String clientInetAddress)
Creates a new JSON-RPC 2.0 request / notification context.
|
MessageContext(String clientHostName,
String clientInetAddress,
boolean secure)
Creates a new JSON-RPC 2.0 request / notification context.
|
MessageContext(String clientHostName,
String clientInetAddress,
boolean secure,
String principalName)
Creates a new JSON-RPC 2.0 request / notification context.
|
MessageContext(String clientHostName,
String clientInetAddress,
boolean secure,
String[] principalNames)
Creates a new JSON-RPC 2.0 request / notification context.
|
MessageContext(URLConnection connection)
Creates a new JSON-RPC 2.0 request / notification context from the
specified URL connection.
|
Modifier and Type | Method and Description |
---|---|
String |
getClientHostName()
Gets the host name of the client that sent the request /
notification.
|
String |
getClientInetAddress()
Gets the IP address of the client that sent the request /
notification.
|
Principal |
getPrincipal()
Returns the first authenticated client principal,
null if
none. |
String |
getPrincipalName()
Returns the first authenticated client principal name,
null
if none. |
String[] |
getPrincipalNames()
Returns the authenticated client principal names,
null
if none. |
Principal[] |
getPrincipals()
Returns the authenticated client principals,
null if
none. |
boolean |
isSecure()
Indicates whether the request / notification was received over a
secure HTTPS connection.
|
String |
toString() |
public MessageContext(String clientHostName, String clientInetAddress, boolean secure, String principalName)
clientHostName
- The client host name, null
if
unknown.clientInetAddress
- The client IP address, null
if
unknown.secure
- Specifies a request received over HTTPS.principalName
- Specifies the authenticated client principle
name, null
if unknown. The name must
not be an empty or blank string.public MessageContext(String clientHostName, String clientInetAddress, boolean secure, String[] principalNames)
clientHostName
- The client host name, null
if
unknown.clientInetAddress
- The client IP address, null
if
unknown.secure
- Specifies a request received over HTTPS.principalNames
- Specifies the authenticated client principle
names, null
if unknown. The names
must not be an empty or blank string.public MessageContext(String clientHostName, String clientInetAddress, boolean secure)
clientHostName
- The client host name, null
if
unknown.clientInetAddress
- The client IP address, null
if
unknown.secure
- Specifies a request received over HTTPS.public MessageContext(String clientHostName, String clientInetAddress)
clientHostName
- The client host name, null
if
unknown.clientInetAddress
- The client IP address, null
if
unknown.public MessageContext()
public MessageContext(javax.servlet.http.HttpServletRequest httpRequest)
httpRequest
- The HTTP request.public MessageContext(URLConnection connection)
getClientInetAddress()
will return null
.connection
- The URL connection, must be established and not
null
.public String getClientHostName()
null
if unknown.public String getClientInetAddress()
null
if unknown.public boolean isSecure()
true
If the request was received over HTTPS,
false
if it was received over plain HTTP.public Principal getPrincipal()
null
if
none.null
if none.public Principal[] getPrincipals()
null
if
none.null
if none.public String getPrincipalName()
null
if none.null
if none.public String[] getPrincipalNames()
null
if none.null
if none.Copyright © 2015 The Transaction Company. All Rights Reserved.