org.glassfish.web.ha.session.management.BaseHASession Maven / Gradle / Ivy
Show all versions of payara-embedded-web Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2016-2021] [Payara Foundation and/or its affiliates]
/*
* BaseHASession.java
*
* Created on October 23, 2003, 11:20 AM
*/
package org.glassfish.web.ha.session.management;
import jakarta.servlet.http.HttpSession;
import jakarta.servlet.http.HttpSessionBindingEvent;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.io.ObjectInputStream;
import java.security.Principal;
import java.util.Enumeration;
import org.apache.catalina.Globals;
import org.apache.catalina.Manager;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.session.StandardSession;
/**
*
* @author lwhite
* @author Rajiv Mordani
*/
public abstract class BaseHASession extends StandardSession
implements HASession {
protected String userName="";
protected boolean persistentFlag = false;
/** Creates a new instance of BaseHASession */
public BaseHASession(Manager manager) {
super(manager);
}
/**
* Set the session identifier for this session.
*
* @param id The new session identifier
*/
public void setId(String id) {
super.setId(id);
// Set the jreplica value for the first request here when the session is created - after that it is done in the valve
ReplicationManagerBase manager = (ReplicationManagerBase)(getManager());
String jReplicaValue = manager.getReplicaFromPredictor(id, null);
if (jReplicaValue != null) {
setNote(Globals.JREPLICA_SESSION_NOTE, jReplicaValue);
}
}
/**
* always return true for isDirty()
* this type of session is always dirty
*/
public abstract boolean isDirty();
/**
* this is deliberately a no-op
* store framework calls this method
* so it must be there but must not have
* any effect
* @param value
*/
public abstract void setDirty(boolean value);
/**
* is the session persistent
*/
public boolean isPersistent() {
return persistentFlag;
}
/**
* this sets the persistent flag
*/
public void setPersistent(boolean value) {
persistentFlag = value;
}
/**
* this returns the user name
*/
public String getUserName() {
return userName;
}
/**
* this sets the user name
*/
public void setUserName(String value) {
userName = value;
}
/**
* Overriding the setPrincipal of StandardSession
*
* @param principal The new Principal, or null if none
*/
public void setPrincipal(Principal principal) {
super.setPrincipal(principal);
this.setDirty(true);
}
public boolean isPersistentFlag() {
return persistentFlag;
}
public void recycle() {
super.recycle();
userName = "";
ssoId = "";
persistentFlag = false;
}
public void save() {
ReplicationManagerBase manager = (ReplicationManagerBase) getManager();
if (manager != null) {
manager.doValveSave(this);
}
}
public void sync() {
HttpSessionBindingEvent event = null;
event = new HttpSessionBindingEvent
((HttpSession) this, null, null);
// Notify special event listeners on sync()
Manager manager = this.getManager();
StandardContext stdContext = (StandardContext) manager.getContainer();
// fire container event
stdContext.fireContainerEvent("sessionSync", event);
}
/**
* Read a serialized version of this session object from the specified
* object input stream.
*
* IMPLEMENTATION NOTE: The reference to the owning Manager
* is not restored by this method, and must be set explicitly.
*
* @param stream The input stream to read from
*
* @exception ClassNotFoundException if an unknown class is specified
* @exception IOException if an input/output error occurs
*/
private void readObject(ObjectInputStream stream)
throws ClassNotFoundException, IOException {
// Deserialize the scalar instance variables (except Manager)
userName = (String) stream.readObject();
}
/**
* Write a serialized version of this session object to the specified
* object output stream.
*
* IMPLEMENTATION NOTE: The owning Manager will not be stored
* in the serialized representation of this Session. After calling
* readObject(), you must set the associated Manager
* explicitly.
*
* IMPLEMENTATION NOTE: Any attribute that is not Serializable
* will be unbound from the session, with appropriate actions if it
* implements HttpSessionBindingListener. If you do not want any such
* attributes, be sure the distributable property of the
* associated Manager is set to true.
*
* @param stream The output stream to write to
*
* @exception IOException if an input/output error occurs
*/
private void writeObject(ObjectOutputStream stream) throws IOException {
// Write the scalar instance variables
stream.writeObject(userName);
}
/**
* Return a string representation of this object.
*/
private CharSequence superToString() {
final StringBuilder sb = new StringBuilder(1000);
sb.append("BaseHASession[");
sb.append(id);
sb.append("]");
sb.append("\n");
sb.append("isValid:").append(getIsValid());
if (getIsValid()) {
final Enumeration attrNamesEnum = getAttributeNamesInternal();
while(attrNamesEnum.hasMoreElements()) {
final String nextAttrName = attrNamesEnum.nextElement();
final Object nextAttrValue = getAttributeInternal(nextAttrName);
sb.append("\n");
sb.append("attrName = ").append(nextAttrName);
sb.append(" : attrValue = ").append(nextAttrValue);
}
}
return sb;
// END S1AS
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder(1200);
sb.append(superToString());
sb.append(" ssoid: ").append(getSsoId());
sb.append(" userName: ").append(getUserName());
sb.append(" version: ").append(getVersion());
sb.append(" persistent: ").append(isPersistent());
return sb.toString();
}
}