/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
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.
/**
 * 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 com.sun.org.apache.xml.internal.security.transforms.params;

import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

import com.sun.org.apache.xml.internal.security.exceptions.XMLSecurityException;
import com.sun.org.apache.xml.internal.security.transforms.TransformParam;
import com.sun.org.apache.xml.internal.security.utils.ElementProxy;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

This Object serves as Content for the ds:Transforms for exclusive
Canonicalization.
 It implements the Element interface and can be used directly in a DOM tree. /**
 * This Object serves as Content for the ds:Transforms for exclusive
 * Canonicalization.
 * <p></p>
 * It implements the {@link Element} interface
 * and can be used directly in a DOM tree.
 *
 */
public class InclusiveNamespaces extends ElementProxy implements TransformParam {

    
Field _TAG_EC_INCLUSIVENAMESPACES /** Field _TAG_EC_INCLUSIVENAMESPACES */
    public static final String _TAG_EC_INCLUSIVENAMESPACES =
        "InclusiveNamespaces";

    
Field _ATT_EC_PREFIXLIST /** Field _ATT_EC_PREFIXLIST */
    public static final String _ATT_EC_PREFIXLIST = "PrefixList";

    
Field ExclusiveCanonicalizationNamespace /** Field ExclusiveCanonicalizationNamespace */
    public static final String ExclusiveCanonicalizationNamespace =
        "http://www.w3.org/2001/10/xml-exc-c14n#";

    
Constructor XPathContainer
Params:
doc – 
prefixList – /**
     * Constructor XPathContainer
     *
     * @param doc
     * @param prefixList
     */
    public InclusiveNamespaces(Document doc, String prefixList) {
        this(doc, InclusiveNamespaces.prefixStr2Set(prefixList));
    }

    
Constructor InclusiveNamespaces
Params:
doc – 
prefixes – /**
     * Constructor InclusiveNamespaces
     *
     * @param doc
     * @param prefixes
     */
    public InclusiveNamespaces(Document doc, Set<String> prefixes) {
        super(doc);

        SortedSet<String> prefixList = null;
        if (prefixes instanceof SortedSet<?>) {
            prefixList = (SortedSet<String>)prefixes;
        } else {
            prefixList = new TreeSet<String>(prefixes);
        }

        StringBuilder sb = new StringBuilder();
        for (String prefix : prefixList) {
            if ("xmlns".equals(prefix)) {
                sb.append("#default ");
            } else {
                sb.append(prefix);
                sb.append(" ");
            }
        }

        setLocalAttribute(InclusiveNamespaces._ATT_EC_PREFIXLIST, sb.toString().trim());
    }

    
Constructor InclusiveNamespaces
Params:
element – 
baseURI – 
Throws:
XMLSecurityException – /**
     * Constructor InclusiveNamespaces
     *
     * @param element
     * @param baseURI
     * @throws XMLSecurityException
     */
    public InclusiveNamespaces(Element element, String baseURI)
        throws XMLSecurityException {
        super(element, baseURI);
    }

    
Method getInclusiveNamespaces
Returns:
The Inclusive Namespace string/**
     * Method getInclusiveNamespaces
     *
     * @return The Inclusive Namespace string
     */
    public String getInclusiveNamespaces() {
        return getLocalAttribute(InclusiveNamespaces._ATT_EC_PREFIXLIST);
    }

    
Decodes the inclusiveNamespaces String and returns all selected namespace prefixes as a Set. The #default namespace token is represented as an empty namespace prefix ("xmlns"). 
 The String inclusiveNamespaces=" xenc    ds #default" is returned as a Set containing the following Strings: 

xmlns
xenc
ds

Params:
inclusiveNamespaces – 
Returns:
A set to string/**
     * Decodes the {@code inclusiveNamespaces} String and returns all
     * selected namespace prefixes as a Set. The {@code #default}
     * namespace token is represented as an empty namespace prefix
     * ({@code "xmlns"}).
     * <BR>
     * The String {@code inclusiveNamespaces=" xenc    ds #default"}
     * is returned as a Set containing the following Strings:
     * <UL>
     * <LI>{@code xmlns}</LI>
     * <LI>{@code xenc}</LI>
     * <LI>{@code ds}</LI>
     * </UL>
     *
     * @param inclusiveNamespaces
     * @return A set to string
     */
    public static SortedSet<String> prefixStr2Set(String inclusiveNamespaces) {
        SortedSet<String> prefixes = new TreeSet<String>();

        if (inclusiveNamespaces == null || inclusiveNamespaces.length() == 0) {
            return prefixes;
        }

        String[] tokens = inclusiveNamespaces.split("\\s");
        for (String prefix : tokens) {
            if (prefix.equals("#default")) {
                prefixes.add("xmlns");
            } else {
                prefixes.add(prefix);
            }
        }

        return prefixes;
    }

    
Method getBaseNamespace
{@inheritDoc}
/**
     * Method getBaseNamespace
     *
     * {@inheritDoc}
     */
    public String getBaseNamespace() {
        return InclusiveNamespaces.ExclusiveCanonicalizationNamespace;
    }

    
Method getBaseLocalName
{@inheritDoc}
/**
     * Method getBaseLocalName
     *
     * {@inheritDoc}
     */
    public String getBaseLocalName() {
        return InclusiveNamespaces._TAG_EC_INCLUSIVENAMESPACES;
    }
}