public class AUTH extends Protocol
Modifier and Type | Class and Description |
---|---|
static interface |
AUTH.UpHandler
Interface to provide callbacks for handling up events
|
Modifier and Type | Field and Description |
---|---|
protected AuthToken |
auth_token
Used on the coordinator to authentication joining member requests against
|
protected static short |
gms_id |
protected Address |
local_addr |
protected List<AUTH.UpHandler> |
up_handlers
List of UpHandler which are called when an up event has been received.
|
Constructor and Description |
---|
AUTH() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
callUpHandlers(Event evt) |
Object |
down(Event evt)
An event is to be sent down the stack.
|
Address |
getAddress() |
String |
getAuthClass() |
AuthToken |
getAuthToken() |
protected List<Object> |
getConfigurableObjects()
After configuring the protocol itself from the properties defined in the XML config, a protocol might have
additional objects which need to be configured.
|
protected static GMS.GmsHeader |
getGMSHeader(Event evt)
Get the header from a GMS message
|
protected static GMS.GmsHeader |
getGMSHeader(Message msg) |
protected boolean |
handleAuthHeader(GMS.GmsHeader gms_hdr,
AuthHeader auth_hdr,
Message msg)
Handles a GMS header
|
void |
init()
Called after instance has been created (null constructor) and before protocol is started.
|
protected static boolean |
needsAuthentication(GMS.GmsHeader hdr) |
void |
register(AUTH.UpHandler handler) |
protected void |
sendJoinRejectionMessage(Address dest,
String error_msg) |
protected void |
sendMergeRejectionMessage(Address dest) |
protected void |
sendRejectionMessage(byte type,
Address dest,
String error_msg) |
void |
setAuthClass(String class_name) |
void |
setAuthToken(AuthToken token) |
void |
unregister(AUTH.UpHandler handler) |
Object |
up(Event evt)
An event was received from the layer below.
|
void |
up(MessageBatch batch)
Sends up a multiple messages in a
MessageBatch . |
accept, destroy, dumpStats, enableStats, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, stop
protected AuthToken auth_token
protected static final short gms_id
protected final List<AUTH.UpHandler> up_handlers
protected Address local_addr
public String getAuthClass()
public AuthToken getAuthToken()
public void setAuthToken(AuthToken token)
public void register(AUTH.UpHandler handler)
public void unregister(AUTH.UpHandler handler)
public Address getAddress()
protected List<Object> getConfigurableObjects()
Protocol
getConfigurableObjects
in class Protocol
public void init() throws Exception
Protocol
public Object up(Event evt)
down_prot.down()
or c) the event (or another event) is sent up
the stack using up_prot.up()
.public void up(MessageBatch batch)
Protocol
MessageBatch
. The sender of the batch is always the same, and so is the
destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed
messages, although the transport itself will create initial MessageBatches that contain only either OOB or
regular messages.
The default processing below sends messages up the stack individually, based on a matching criteria
(calling Protocol.accept(org.jgroups.Message)
), and - if true - calls Protocol.up(org.jgroups.Event)
for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.
Subclasses should check if there are any messages destined for them (e.g. using
MessageBatch.getMatchingMessages(short,boolean)
), then possibly remove and process them and finally pass
the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all
encrypted messages in the batch, not remove them, and pass the batch up when done.public Object down(Event evt)
down_prot.down()
. In case of a GET_ADDRESS event (which tries to
retrieve the stack's address from one of the bottom layers), the layer may need to send
a new response event back up the stack using up_prot.up()
.protected static boolean needsAuthentication(GMS.GmsHeader hdr)
protected boolean handleAuthHeader(GMS.GmsHeader gms_hdr, AuthHeader auth_hdr, Message msg)
gms_hdr
- msg
- protected void sendMergeRejectionMessage(Address dest)
protected boolean callUpHandlers(Event evt)
protected static GMS.GmsHeader getGMSHeader(Event evt)
evt
- The event object passed in to AUTHprotected static GMS.GmsHeader getGMSHeader(Message msg)
Copyright © 2014 JBoss, a division of Red Hat. All rights reserved.