001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2016, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose;
019
020
021import java.security.Signature;
022
023import com.nimbusds.jose.util.Base64URL;
024
025
026/**
027 * Completable JSON Web Signature (JWS) object signing. Implementations must be
028 * thread-safe.
029 */
030public interface CompletableJWSObjectSigning {
031        
032        
033        /**
034         * Returns the initialised signature object. Enables the binding of a
035         * user verification to a specific instance of a
036         * {@linkplain java.security.Signature}.
037         *
038         * @return The initialised {@linkplain java.security.Signature} object.
039         */
040        Signature getInitializedSignature();
041        
042        
043        /**
044         * Completes the JWS object signing.
045         *
046         * @return The resulting signature part (third part) of the JWS object.
047         *
048         * @throws JOSEException If the JWS object couldn't be signed.
049         */
050        Base64URL complete()
051                throws JOSEException;
052}