/*
* 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.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed 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.naming;
import java.util.Hashtable;
import javax.naming.NamingException;
/**
* Handles the access control on the JNDI contexts.
*
* @author Remy Maucherat
* @version $Revision: 1.2 $ $Date: 2005/12/08 01:29:02 $
*/
public class ContextAccessController {
// -------------------------------------------------------------- Variables
/**
* Catalina context names on which writing is not allowed.
*/
private static Hashtable<Object, Object> readOnlyContexts =
new Hashtable<Object, Object>();
/**
* Security tokens repository.
*/
private static Hashtable<Object, Object> securityTokens =
new Hashtable<Object, Object>();
// --------------------------------------------------------- Public Methods
/**
* Set a security token for a context. Can be set only once.
*
* @param name Name of the context
* @param token Security token
*/
public static void setSecurityToken(Object name, Object token) {
if ((!securityTokens.containsKey(name)) && (token != null)) {
securityTokens.put(name, token);
}
}
/**
* Remove a security token for a context.
*
* @param name Name of the context
* @param token Security token
*/
public static void unsetSecurityToken(Object name, Object token) {
if (checkSecurityToken(name, token)) {
securityTokens.remove(name);
}
}
/**
* Check a submitted security token. The submitted token must be equal to
* the token present in the repository. If no token is present for the
* context, then returns true.
*
* @param name Name of the context
* @param token Submitted security token
*/
public static boolean checkSecurityToken
(Object name, Object token) {
Object refToken = securityTokens.get(name);
return (refToken == null || refToken.equals(token));
}
/**
* Allow writing to a context.
*
* @param name Name of the context
* @param token Security token
*/
public static void setWritable(Object name, Object token) {
if (checkSecurityToken(name, token))
readOnlyContexts.remove(name);
}
/**
* Set whether or not a context is writable.
*
* @param name Name of the context
*/
public static void setReadOnly(Object name) {
readOnlyContexts.put(name, name);
}
/**
* Returns if a context is writable.
*
* @param name Name of the context
*/
public static boolean isWritable(Object name) {
return !(readOnlyContexts.containsKey(name));
}
}