org.xmlBlaster.authentication.plugins
Class DataHolder

java.lang.Object
  org.xmlBlaster.authentication.plugins.DataHolder

public class DataHolder
extends java.lang.Object

Container to transport information to the isAuthorized() method.

Author:

xmlblast@marcelruff.info

Field Summary

private MethodName	action
private XmlBlasterException	exceptionToThrow
private MsgUnit	msgUnit
private java.lang.String	notAuthorizedInfo

Constructor Summary

DataHolder(MethodName action, MsgUnit msgUnit)

Method Summary

MethodName	getAction()
Destination	getDestination() Convenience method to access PtP destination
SessionName	getDestinationSessionName() Convenience method to access PtP destination
XmlBlasterException	getExceptionToThrow()
java.lang.String	getKeyOid() The key oid
java.lang.String	getKeyUrl() The key url notation like "exact:hello", "xpath://key", "domain:sport"
MsgUnit	getMsgUnit()
java.lang.String	getNotAuthorizedInfo()
QosData	getQosData() Convenience method to access QoS of MsgUnit
void	setExceptionToThrow(XmlBlasterException exceptionToThrow) Allows a security plugin to throw another exception instead of ErrorCode.USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED when returning false during isAuthorized() call
void	setNotAuthorizedInfo(java.lang.String notAuthorizedInfo)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

action

private final MethodName action

msgUnit

private final MsgUnit msgUnit

notAuthorizedInfo

private transient java.lang.String notAuthorizedInfo

exceptionToThrow

private transient XmlBlasterException exceptionToThrow

Constructor Detail

DataHolder

public DataHolder(MethodName action,
                  MsgUnit msgUnit)

Parameters:

action - May not be null

msgUnit - May not be null

Method Detail

getAction

public MethodName getAction()

Returns:

Returns the action, never null

getMsgUnit

public MsgUnit getMsgUnit()

Returns:

Returns the msgUnit, is never null

getKeyOid

public java.lang.String getKeyOid()

The key oid

Returns:

Never null, but can be empty

getKeyUrl

public java.lang.String getKeyUrl()

The key url notation like "exact:hello", "xpath://key", "domain:sport"

Returns:

Never null, but can be empty

getQosData

public QosData getQosData()

Convenience method to access QoS of MsgUnit

Returns:

Never null

getDestinationSessionName

public SessionName getDestinationSessionName()

Convenience method to access PtP destination

Returns:

null if no PtP publish message

getDestination

public Destination getDestination()

Convenience method to access PtP destination

Returns:

null if no PtP publish message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNotAuthorizedInfo

public java.lang.String getNotAuthorizedInfo()

Returns:

Usuall null, can contain additional info for caller in error case

setNotAuthorizedInfo

public void setNotAuthorizedInfo(java.lang.String notAuthorizedInfo)

getExceptionToThrow

public XmlBlasterException getExceptionToThrow()

setExceptionToThrow

public void setExceptionToThrow(XmlBlasterException exceptionToThrow)

Allows a security plugin to throw another exception instead of ErrorCode.USER_SECURITY_AUTHORIZATION_NOTAUTHORIZED when returning false during isAuthorized() call