com.redhat.lightblue

Class ClientIdentification

java.lang.Object

com.redhat.lightblue.util.JsonObject

com.redhat.lightblue.ClientIdentification

All Implemented Interfaces:

Serializable

public abstract class ClientIdentification
extends JsonObject

This is the base class for implementation specific client identification. Implementations of this class must contain data that identifies the caller of an API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientIdentification()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getPrincipal() Get the principal identifying the client.
abstract boolean	isUserInRole(String role) Return the roles the caller is in.
com.fasterxml.jackson.databind.JsonNode	toJson() Default implementation of toJson() returns an empty object node

Methods inherited from class com.redhat.lightblue.util.JsonObject

getFactory, getSourceNode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientIdentification

public ClientIdentification()

Method Detail

getPrincipal

public abstract String getPrincipal()

Get the principal identifying the client.

isUserInRole

public abstract boolean isUserInRole(String role)

Return the roles the caller is in.

toJson

public com.fasterxml.jackson.databind.JsonNode toJson()

Default implementation of toJson() returns an empty object node

Specified by:

toJson in class JsonObject