org.apache.xml.security.signature.reference.ReferenceOctetStreamData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation

Apache XML Security for Java supports XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002, and XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002. As of version 1.4, the library supports the standard Java API JSR-105: XML Digital Signature APIs.

There is a newer version: 4.0.2

Show newest version

/**
 * 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.
 */
/*
 * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
 */
/*
 * $Id$
 */
package org.apache.xml.security.signature.reference;

import java.io.InputStream;

/**
 * A representation of a ReferenceData type containing an OctetStream.
 */
public class ReferenceOctetStreamData implements ReferenceData {
    private InputStream octetStream;
    private String uri;
    private String mimeType;

    /**
     * Creates a new ReferenceOctetStreamData.
     *
     * @param octetStream the input stream containing the octets
     * @throws NullPointerException if octetStream is 
     *    null
     */
    public ReferenceOctetStreamData(InputStream octetStream) {
        if (octetStream == null) {
            throw new NullPointerException("octetStream is null");
        }
        this.octetStream = octetStream;
    }

    /**
     * Creates a new ReferenceOctetStreamData.
     *
     * @param octetStream the input stream containing the octets
     * @param uri the URI String identifying the data object (may be 
     *    null) 
     * @param mimeType the MIME type associated with the data object (may be 
     *    null) 
     * @throws NullPointerException if octetStream is 
     *    null
     */
    public ReferenceOctetStreamData(InputStream octetStream, String uri, 
        String mimeType) {
        if (octetStream == null) {
            throw new NullPointerException("octetStream is null");
        }
        this.octetStream = octetStream;
        this.uri = uri;
        this.mimeType = mimeType;
    }

    /**
     * Returns the input stream of this ReferenceOctetStreamData.
     *
     * @return the input stream of this ReferenceOctetStreamData.
     */
    public InputStream getOctetStream() {
        return octetStream;
    }

    /**
     * Returns the URI String identifying the data object represented by this
     * ReferenceOctetStreamData.
     *
     * @return the URI String or null if not applicable
     */
    public String getURI() {
        return uri;
    }

    /**
     * Returns the MIME type associated with the data object represented by this
     * ReferenceOctetStreamData.
     *
     * @return the MIME type or null if not applicable
     */
    public String getMimeType() {
        return mimeType;
    }
    
}