org.glassfish.contextpropagation.internal.SimpleMap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006-2012 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.
*/
package org.glassfish.contextpropagation.internal;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import org.glassfish.contextpropagation.ContextLifecycle;
import org.glassfish.contextpropagation.PropagationMode;
import org.glassfish.contextpropagation.bootstrap.ContextBootstrap;
import org.glassfish.contextpropagation.bootstrap.LoggerAdapter;
import org.glassfish.contextpropagation.bootstrap.LoggerAdapter.Level;
import org.glassfish.contextpropagation.bootstrap.LoggerAdapter.MessageID;
import org.glassfish.contextpropagation.internal.Entry.ContextType;
/*
* This map is used by the AccessControlleMap, which is itself used by ContextMap.
* It has full access to the ContextMap data. It takes care of the
* following tasks:
* - validating the data
* - notifying LifecycleListeners of the following events: context
* added*, changed or removed.
* * records the object to notify so that the ContextMapPropagator may send
* the notifications after we are done reading all the contexts.
*/
public class SimpleMap {
private final LoggerAdapter logger = ContextBootstrap.getLoggerAdapter();
HashMap map = new HashMap();
private List addedContexts;
Entry getEntry(String key) {
validate("get", key);
Entry entry = map.get(key);
if (logger.isLoggable(Level.DEBUG)) {
logger.log(Level.DEBUG, MessageID.OPERATION, "getEntry", key, entry);
}
return entry;
}
protected void prepareToPropagate() {
addedContexts = new LinkedList();
}
protected List getAddedContextLifecycles() {
List result = addedContexts;
addedContexts = null;
return result;
}
@SuppressWarnings("unchecked")
public T get(String key) {
return (T) extractResult(key, getEntry(key), "get");
}
@SuppressWarnings("unchecked")
private T extractResult(String key, Entry entry, String operation) {
T result = (T) (entry == null ? null : entry.value);
if (logger.isLoggable(Level.DEBUG)) {
logger.log(Level.DEBUG, MessageID.OPERATION, operation, key, result);
}
return result;
}
@SuppressWarnings("unchecked")
public T put(String key, Entry entry) {
validate(key, entry);
T value = (T) entry.getValue();
Entry oldEntry = map.put(key, entry);
if (oldEntry != null && (oldEntry.getValue() instanceof ContextLifecycle)) {
((ContextLifecycle) oldEntry.value).contextChanged(value);
}
if (entry.getValue() instanceof ContextLifecycle) {
ContextLifecycle ctx = (ContextLifecycle) entry.getValue();
if (addedContexts == null) {
ctx.contextAdded();
} else {
addedContexts.add(ctx);
}
}
if (logger.isLoggable(Level.DEBUG)) {
logger.log(Level.DEBUG, MessageID.PUT, key, value, oldEntry == null ? null : oldEntry.value);
}
return (T) (oldEntry == null ? null : oldEntry.value);
}
@SuppressWarnings("unchecked")
public T remove(String key) {
validate("remove", key);
Entry entry = (Entry) map.remove(key);
if (entry != null) {
if (entry.getValue() instanceof ContextLifecycle) {
((ContextLifecycle) entry.getValue()).contextRemoved();
}
if (entry.contextType == ContextType.VIEW_CAPABLE) {
((ViewImpl) entry.getView()).clean();
}
}
return (T) extractResult(key, entry, "remove");
}
private void validate(String key, Entry entry) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Cannot use null key");
}
if (entry == null) {
throw new IllegalArgumentException("Cannot use null entry");
}
if (entry.value == null) {
throw new IllegalArgumentException("Cannot use null value");
}
entry.validate();
}
private void validate(String operation, String key) {
if (key == null || key.isEmpty()) {
throw new IllegalArgumentException("Cannot use null key");
}
}
public Iterator> iterator(final Filter filter, final PropagationMode mode) {
return new Iterator>() {
Iterator> it = map.entrySet().iterator();
Map.Entry next;
Map.Entry last;
@Override
public boolean hasNext() {
return next == null ? findNext() : true;
}
@Override
public Map.Entry next() {
if (next == null && !findNext()) {
throw new NoSuchElementException();
} else {
last = next;
next = null;
return last;
}
}
private boolean findNext() {
while (it.hasNext()) {
Map.Entry entry = it.next();
if (filter.keep(entry, mode)) {
next = entry;
return true;
}
}
next = null;
return false;
}
@Override
public void remove() {
if (last == null) throw new IllegalStateException("Make sure that next is called before calling remove, or that there are elements to remove");
it.remove();
if (logger.isLoggable(Level.DEBUG)) {
logger.log(Level.DEBUG, MessageID.OPERATION, "remove", last.getKey(), last.getValue().value);
}
last = null;
}
};
}
public interface Filter {
boolean keep(Map.Entry mapEntry, PropagationMode mode);
}
}