com.sun.xml.ws.security.opt.crypto.jaxb.JAXBCryptoContext Maven / Gradle / Ivy
Show all versions of xws-security Show documentation
/*
* JAXBCryptoContext.java
*
* Created on January 24, 2006, 11:53 AM
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (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/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.security.opt.crypto.jaxb;
import java.util.HashMap;
import javax.xml.crypto.KeySelector;
import javax.xml.crypto.URIDereferencer;
/**
*
* @author Abhijit Das
*/
public class JAXBCryptoContext implements javax.xml.crypto.XMLCryptoContext {
private String baseURI = null;
private KeySelector keySelector = null;
private URIDereferencer uriDereferencer = null;
private HashMap namespacePrefix = null;
private String defaultNamespacePrefix = null;
private HashMap property = null;
private HashMap context = null;
/** Creates a new instance of JAXBCryptoContext */
public JAXBCryptoContext() {
}
/**
* Returns the base URI.
*
* @return the base URI, or null if not specified
* @see #setBaseURI(String)
*/
public String getBaseURI() {
return baseURI;
}
/**
* Sets the base URI.
*
* @param baseURI the base URI, or null to remove current
* value
* @throws IllegalArgumentException if baseURI is not RFC
* 2396 compliant
* @see #getBaseURI
*/
public void setBaseURI(String baseURI) {
this.baseURI = baseURI;
}
/**
* Returns the key selector for finding a key.
*
* @return the key selector, or null if not specified
* @see #setKeySelector(KeySelector)
*/
public KeySelector getKeySelector() {
return keySelector;
}
/**
* Sets the key selector for finding a key.
*
* @param ks the key selector, or null to remove the current
* setting
* @see #getKeySelector
*/
public void setKeySelector(KeySelector keySelector) {
this.keySelector = keySelector;
}
/**
* Returns a URIDereferencer that is used to dereference
* {@link URIReference}s.
*
* @return the URIDereferencer, or null if not
* specified
* @see #setURIDereferencer(URIDereferencer)
*/
public URIDereferencer getURIDereferencer() {
return uriDereferencer;
}
/**
* Sets a URIDereferencer that is used to dereference
* {@link URIReference}s. The specified URIDereferencer
* is used in place of an implementation's default
* URIDereferencer.
*
* @param dereferencer the URIDereferencer, or
* null to remove any current setting
* @see #getURIDereferencer
*/
public void setURIDereferencer(URIDereferencer uriDereferencer) {
this.uriDereferencer = uriDereferencer;
}
/**
* Returns the namespace prefix that the specified namespace URI is
* associated with. Returns the specified default prefix if the specified
* namespace URI has not been bound to a prefix. To bind a namespace URI
* to a prefix, call the {@link #putNamespacePrefix putNamespacePrefix}
* method.
*
* @param namespaceURI a namespace URI
* @param defaultPrefix the prefix to be returned in the event that the
* the specified namespace URI has not been bound to a prefix.
* @return the prefix that is associated with the specified namespace URI,
* or defaultPrefix if the URI is not registered. If
* the namespace URI is registered but has no prefix, an empty string
* ("") is returned.
* @throws NullPointerException if namespaceURI is
* null
* @see #putNamespacePrefix(String, String)
*/
public String getNamespacePrefix(String namespaceURI, String defaultPrefix) {
if ( namespacePrefix == null ) {
return defaultPrefix;
}
Object prefix = namespacePrefix.get(namespaceURI);
if ( prefix == null ) {
return defaultPrefix;
} else if ( prefix.equals("" )) {
return defaultPrefix;
} else {
return prefix.toString();
}
}
/**
* Maps the specified namespace URI to the specified prefix. If there is
* already a prefix associated with the specified namespace URI, the old
* prefix is replaced by the specified prefix.
*
* @param namespaceURI a namespace URI
* @param prefix a namespace prefix (or null to remove any
* existing mapping). Specifying the empty string ("")
* binds no prefix to the namespace URI.
* @return the previous prefix associated with the specified namespace
* URI, or null if there was none
* @throws NullPointerException if namespaceURI is
* null
* @see #getNamespacePrefix(String, String)
*/
public String putNamespacePrefix(String namespaceURI, String prefix) {
if ( namespaceURI == null ) {
return null;
}
if ( namespacePrefix == null ) {
namespacePrefix = new HashMap();
}
//Get the old prefix
Object oldPrefix = namespacePrefix.get(namespaceURI);
if ( prefix == null && oldPrefix != null ) {
//Remove the mapping and return the oldprefix
return namespacePrefix.remove(namespaceURI).toString();
}
if ( prefix != "" )
namespacePrefix.put(namespaceURI, prefix);
if(oldPrefix != null)
return oldPrefix.toString();
return null;
}
/**
* Returns the default namespace prefix. The default namespace prefix
* is the prefix for all namespace URIs not explicitly set by the
* {@link #putNamespacePrefix putNamespacePrefix} method.
*
* @return the default namespace prefix, or null if none has
* been set.
* @see #setDefaultNamespacePrefix(String)
*/
public String getDefaultNamespacePrefix() {
return defaultNamespacePrefix;
}
/**
* Sets the default namespace prefix. This sets the namespace prefix for
* all namespace URIs not explicitly set by the {@link #putNamespacePrefix
* putNamespacePrefix} method.
*
* @param defaultPrefix the default namespace prefix, or null
* to remove the current setting. Specify the empty string
* ("") to bind no prefix.
* @see #getDefaultNamespacePrefix
*/
public void setDefaultNamespacePrefix(String defaultNamespacePrefix) {
this.defaultNamespacePrefix = defaultNamespacePrefix;
}
/**
* Sets the specified property.
*
* @param name the name of the property
* @param value the value of the property to be set
* @return the previous value of the specified property, or
* null if it did not have a value
* @throws NullPointerException if name is null
* @see #getProperty(String)
*/
public Object setProperty(String name, Object value) {
if ( property == null ) {
property = new HashMap();
}
return property.put(name, value);
}
/**
* Returns the value of the specified property.
*
* @param name the name of the property
* @return the current value of the specified property, or
* null if it does not have a value
* @throws NullPointerException if name is null
* @see #setProperty(String, Object)
*/
public Object getProperty(String name) {
if ( property != null ) {
return property.get(name);
} else {
return null;
}
}
/**
* Returns the value to which this context maps the specified key.
*
* More formally, if this context contains a mapping from a key
* k to a value v such that
* (key==null ? k==null : key.equals(k)), then this method
* returns v; otherwise it returns null. (There
* can be at most one such mapping.)
*
*
This method is useful for retrieving arbitrary information that is
* specific to the cryptographic operation that this context is used for.
*
* @param key the key whose associated value is to be returned
* @return the value to which this context maps the specified key, or
* null if there is no mapping for the key
* @see #put(Object, Object)
*/
public Object get(Object key) {
if ( context != null ) {
return context.get(key);
} else {
return null;
}
}
/**
* Associates the specified value with the specified key in this context.
* If the context previously contained a mapping for this key, the old
* value is replaced by the specified value.
*
*
This method is useful for storing arbitrary information that is
* specific to the cryptographic operation that this context is used for.
*
* @param key key with which the specified value is to be associated with
* @param value value to be associated with the specified key
* @return the previous value associated with the key, or null
* if there was no mapping for the key
* @throws IllegalArgumentException if some aspect of this key or value
* prevents it from being stored in this context
* @see #get(Object)
*/
public Object put(Object key, Object value) {
if ( context == null ) {
context = new HashMap();
}
return context.put(key, value);
}
}