org.apache.catalina.ha.session.DeltaRequest Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.ha.session;
/**
* This class is used to track the series of actions that happens when
* a request is executed. These actions will then translate into invocations of methods
* on the actual session.
* This class is NOT thread safe. One DeltaRequest per session
* @author Filip Hanik
* @version 1.0
*/
import java.io.ByteArrayOutputStream;
import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.security.Principal;
import java.util.LinkedList;
import org.apache.catalina.realm.GenericPrincipal;
import org.apache.tomcat.util.res.StringManager;
public class DeltaRequest implements Externalizable {
public static final org.apache.juli.logging.Log log =
org.apache.juli.logging.LogFactory.getLog( DeltaRequest.class );
/**
* The string manager for this package.
*/
protected static final StringManager sm = StringManager
.getManager(Constants.Package);
public static final int TYPE_ATTRIBUTE = 0;
public static final int TYPE_PRINCIPAL = 1;
public static final int TYPE_ISNEW = 2;
public static final int TYPE_MAXINTERVAL = 3;
public static final int TYPE_AUTHTYPE = 4;
public static final int ACTION_SET = 0;
public static final int ACTION_REMOVE = 1;
public static final String NAME_PRINCIPAL = "__SET__PRINCIPAL__";
public static final String NAME_MAXINTERVAL = "__SET__MAXINTERVAL__";
public static final String NAME_ISNEW = "__SET__ISNEW__";
public static final String NAME_AUTHTYPE = "__SET__AUTHTYPE__";
private String sessionId;
private LinkedList actions = new LinkedList();
private LinkedList actionPool =
new LinkedList();
private boolean recordAllActions = false;
public DeltaRequest() {
}
public DeltaRequest(String sessionId, boolean recordAllActions) {
this.recordAllActions=recordAllActions;
if(sessionId != null)
setSessionId(sessionId);
}
public void setAttribute(String name, Object value) {
int action = (value==null)?ACTION_REMOVE:ACTION_SET;
addAction(TYPE_ATTRIBUTE,action,name,value);
}
public void removeAttribute(String name) {
int action = ACTION_REMOVE;
addAction(TYPE_ATTRIBUTE,action,name,null);
}
public void setMaxInactiveInterval(int interval) {
int action = ACTION_SET;
addAction(TYPE_MAXINTERVAL,action,NAME_MAXINTERVAL,Integer.valueOf(interval));
}
/**
* convert principal at SerializablePrincipal for backup nodes.
* Only support principals from type {@link GenericPrincipal GenericPrincipal}
* @param p Session principal
* @see GenericPrincipal
*/
public void setPrincipal(Principal p) {
int action = (p==null)?ACTION_REMOVE:ACTION_SET;
SerializablePrincipal sp = null;
if ( p != null ) {
if(p instanceof GenericPrincipal) {
sp = SerializablePrincipal.createPrincipal((GenericPrincipal)p);
if(log.isDebugEnabled())
log.debug(sm.getString("deltaRequest.showPrincipal", p.getName() , getSessionId()));
} else
log.error(sm.getString("deltaRequest.wrongPrincipalClass",p.getClass().getName()));
}
addAction(TYPE_PRINCIPAL,action,NAME_PRINCIPAL,sp);
}
public void setNew(boolean n) {
int action = ACTION_SET;
addAction(TYPE_ISNEW,action,NAME_ISNEW,Boolean.valueOf(n));
}
public void setAuthType(String authType) {
int action = (authType==null)?ACTION_REMOVE:ACTION_SET;
addAction(TYPE_AUTHTYPE,action,NAME_AUTHTYPE, authType);
}
protected void addAction(int type,
int action,
String name,
Object value) {
AttributeInfo info = null;
if ( this.actionPool.size() > 0 ) {
try {
info = actionPool.removeFirst();
}catch ( Exception x ) {
log.error("Unable to remove element:",x);
info = new AttributeInfo(type, action, name, value);
}
info.init(type,action,name,value);
} else {
info = new AttributeInfo(type, action, name, value);
}
//if we have already done something to this attribute, make sure
//we don't send multiple actions across the wire
if ( !recordAllActions) {
try {
actions.remove(info);
} catch (java.util.NoSuchElementException x) {
//do nothing, we wanted to remove it anyway
}
}
//add the action
actions.addLast(info);
}
public void execute(DeltaSession session, boolean notifyListeners) {
if ( !this.sessionId.equals( session.getId() ) )
throw new java.lang.IllegalArgumentException("Session id mismatch, not executing the delta request");
session.access();
for ( int i=0; i();
else
actions.clear();
for (int i = 0; i < cnt; i++) {
AttributeInfo info = null;
if (this.actionPool.size() > 0) {
try {
info = actionPool.removeFirst();
} catch ( Exception x ) {
log.error("Unable to remove element",x);
info = new AttributeInfo();
}
}
else {
info = new AttributeInfo();
}
info.readExternal(in);
actions.addLast(info);
}//for
}
@Override
public void writeExternal(java.io.ObjectOutput out ) throws java.io.IOException {
//sessionId - String
//recordAll - boolean
//size - int
//AttributeInfo - in an array
out.writeUTF(getSessionId());
out.writeBoolean(recordAllActions);
out.writeInt(getSize());
for ( int i=0; i