001: /*
002: * $Id: Authenticator.java,v 1.2 2007/05/29 22:11:30 ofung Exp $
003: */
004:
005: /*
006: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
007: *
008: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
009: *
010: * The contents of this file are subject to the terms of either the GNU
011: * General Public License Version 2 only ("GPL") or the Common Development
012: * and Distribution License("CDDL") (collectively, the "License"). You
013: * may not use this file except in compliance with the License. You can obtain
014: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
015: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
016: * language governing permissions and limitations under the License.
017: *
018: * When distributing the software, include this License Header Notice in each
019: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
020: * Sun designates this particular file as subject to the "Classpath" exception
021: * as provided by Sun in the GPL Version 2 section of the License file that
022: * accompanied this code. If applicable, add the following below the License
023: * Header, with the fields enclosed by brackets [] replaced by your own
024: * identifying information: "Portions Copyrighted [year]
025: * [name of copyright owner]"
026: *
027: * Contributor(s):
028: *
029: * If you wish your version of this file to be governed by only the CDDL or
030: * only the GPL Version 2, indicate your decision by adding "[Contributor]
031: * elects to include this software in this distribution under the [CDDL or GPL
032: * Version 2] license." If you don't indicate a single choice of license, a
033: * recipient has the option to distribute your version of this file under
034: * either the CDDL, the GPL Version 2 or to extend the choice of license to
035: * its licensees as provided above. However, if you add GPL Version 2 code
036: * and therefore, elected the GPL Version 2 license, then the option applies
037: * only if the new code is made subject to such option by the copyright
038: * holder.
039: */
040:
041: package com.sun.xml.ws.security.trust.elements;
042:
043: import java.util.List;
044:
045: /**
046: * Provides verification (authentication) of a computed hash.
047: *
048: * @author WS-Trust Implementation Team.
049: */
050:
051: public interface Authenticator {
052:
053: /**
054: * Gets the value of the any property.
055: *
056: * <p>
057: * This accessor method returns a reference to the live list,
058: * not a snapshot. Therefore any modification you make to the
059: * returned list will be present inside the JAXB object.
060: * This is why there is not a <CODE>set</CODE> method for the any property.
061: *
062: * <p>
063: * For example, to add a new item, do as follows:
064: * <pre>
065: * getAny().add(newItem);
066: * </pre>
067: *
068: *
069: * <p>
070: * Objects of the following type(s) are allowed in the list
071: * {@link Element }
072: * {@link Object }
073: *
074: *
075: */
076: List<Object> getAny();
077:
078: /**
079: * Gets the raw value of the combinedHash property.
080: *
081: * @return byte[]
082: */
083: byte[] getRawCombinedHash();
084:
085: /**
086: * Sets the value of the combinedHash property.
087: *
088: * @param rawCombinedHash {@link byte[]}
089: */
090: void setRawCombinedHash(byte[] rawCombinedHash);
091:
092: /**
093: * Gets the value of the base64 encoded combinedHash property.
094: *
095: * @return {@link String}
096: */
097: String getTextCombinedHash();
098:
099: /**
100: * Sets the value of the base 64 encoded combinedHash property.
101: *
102: * @param combinedHash {@link String}
103: */
104: void setTextCombinedHash(String combinedHash);
105:
106: }
|