Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BC12D10760 for ; Sat, 10 Aug 2013 22:26:34 +0000 (UTC) Received: (qmail 54825 invoked by uid 500); 10 Aug 2013 22:26:34 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 54759 invoked by uid 500); 10 Aug 2013 22:26:34 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 54752 invoked by uid 99); 10 Aug 2013 22:26:34 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 10 Aug 2013 22:26:34 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 10 Aug 2013 22:26:29 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 3E7D32388C27 for ; Sat, 10 Aug 2013 22:25:29 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r874057 [13/31] - in /websites/production/commons/content/sandbox/commons-openpgp: ./ apidocs/ apidocs/org/apache/commons/openpgp/ apidocs/org/apache/commons/openpgp/ant/ apidocs/org/apache/commons/openpgp/ant/class-use/ apidocs/org/apache/... Date: Sat, 10 Aug 2013 22:25:21 -0000 To: commits@commons.apache.org From: dennisl@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130810222529.3E7D32388C27@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpSigner.html ============================================================================== --- websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpSigner.html (original) +++ websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpSigner.html Sat Aug 10 22:25:17 2013 @@ -12,129 +12,129 @@
 
- - +
Classes in this File Line Coverage Branch Coverage Complexity
OpenPgpSigner
N/A
N/A
1
OpenPgpSigner$1
0%
0/1
N/A
1
OpenPgpSigner
N/A
N/A
1
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 import java.io.InputStream;
 22  
 import java.io.OutputStream;
 23  
 
 24  
 /**
 25  
  * Interface for signing data with OpenPGP.
 26  
  *
 27  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 28  
  * @todo perhaps should have different interface methods for the default key
 29  
  * @todo should the exception be a signature exception instead of a common one?
 30  
  */
 31  
 public interface OpenPgpSigner
 32  
 {
 33  0
     String ROLE = OpenPgpSigner.class.getName();
 34  
 
 35  
     /**
 36  
      * Sign a piece of data with the given key.
 37  
      *
 38  
      * @param data         the data to sign
 39  
      * @param signedOutput the signed output data
 40  
      * @param keyId        the key ID of the key used to sign it
 41  
      * @param keyRing      the keyring containing the key above
 42  
      * @param asciiArmor   whether to ascii armor the output
 43  
      */
 44  
     void sign( InputStream data, OutputStream signedOutput, String keyId, KeyRing keyRing, boolean asciiArmor )
 45  
         throws OpenPgpException;
 46  
 
 47  
     /**
 48  
      * Sign a piece of data with the given key, storing the signature in a detached output.
 49  
      *
 50  
      * @param data       the data to sign
 51  
      * @param signature  the detached signature
 52  
      * @param keyId      the key ID of the key used to sign it
 53  
      * @param keyRing    the keyring containing the key above
 54  
      * @param asciiArmor whether to ascii armor the output
 55  
      */
 56  
     void detachedSign( InputStream data, OutputStream signature, String keyId, KeyRing keyRing, boolean asciiArmor )
 57  
         throws OpenPgpException, IOException;
 58  
 }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 import java.io.InputStream;
 22  
 import java.io.OutputStream;
 23  
 
 24  
 /**
 25  
  * Interface for signing data with OpenPGP.
 26  
  *
 27  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 28  
  * @todo perhaps should have different interface methods for the default key
 29  
  * @todo should the exception be a signature exception instead of a common one?
 30  
  */
 31  
 public interface OpenPgpSigner
 32  
 {
 33  
     String ROLE = OpenPgpSigner.class.getName();
 34  
 
 35  
     /**
 36  
      * Sign a piece of data with the given key.
 37  
      *
 38  
      * @param data         the data to sign
 39  
      * @param signedOutput the signed output data
 40  
      * @param keyId        the key ID of the key used to sign it
 41  
      * @param keyRing      the keyring containing the key above
 42  
      * @param asciiArmor   whether to ascii armor the output
 43  
      */
 44  
     void sign( InputStream data, OutputStream signedOutput, String keyId, KeyRing keyRing, boolean asciiArmor )
 45  
         throws OpenPgpException;
 46  
 
 47  
     /**
 48  
      * Sign a piece of data with the given key, storing the signature in a detached output.
 49  
      *
 50  
      * @param data       the data to sign
 51  
      * @param signature  the detached signature
 52  
      * @param keyId      the key ID of the key used to sign it
 53  
      * @param keyRing    the keyring containing the key above
 54  
      * @param asciiArmor whether to ascii armor the output
 55  
      */
 56  
     void detachedSign( InputStream data, OutputStream signature, String keyId, KeyRing keyRing, boolean asciiArmor )
 57  
         throws OpenPgpException, IOException;
 58  
 }
- + - + \ No newline at end of file Modified: websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSignatureVerifier.html ============================================================================== --- websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSignatureVerifier.html (original) +++ websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSignatureVerifier.html Sat Aug 10 22:25:17 2013 @@ -12,131 +12,131 @@
 
- - +
Classes in this File Line Coverage Branch Coverage Complexity
OpenPgpStreamingSignatureVerifier
N/A
N/A
1
OpenPgpStreamingSignatureVerifier$1
0%
0/1
N/A
1
OpenPgpStreamingSignatureVerifier
N/A
N/A
1
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 
 22  
 /**
 23  
  * An interface for updating an OpenPGP signature on the fly with streaming data.
 24  
  *
 25  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 26  
  */
 27  
 public interface OpenPgpStreamingSignatureVerifier
 28  
 {
 29  0
     String ROLE = OpenPgpStreamingSignatureVerifier.class.getName();
 30  
 
 31  
     /**
 32  
      * Update the signature with the next block from the data buffer.
 33  
      *
 34  
      * @param buf the buffer
 35  
      * @throws org.apache.commons.openpgp.OpenPgpException if the buffer is not valid for updating the signature
 36  
      */
 37  
     void update( byte[] buf )
 38  
         throws OpenPgpException;
 39  
 
 40  
     /**
 41  
      * Update the signature with the next block from the data buffer.
 42  
      *
 43  
      * @param buf    the buffer
 44  
      * @param offset offset within the buffer to start from
 45  
      * @param length number of bytes in the buffer to read from
 46  
      * @throws org.apache.commons.openpgp.OpenPgpException if the buffer is not valid for updating the signature
 47  
      */
 48  
     void update( byte[] buf, int offset, int length )
 49  
         throws OpenPgpException;
 50  
 
 51  
     /**
 52  
      * Finish and verify the signature that has been obtained.
 53  
      *
 54  
      * @return the status of the signature
 55  
      * @throws org.apache.commons.openpgp.OpenPgpException if the signature is not in a consistent or complete state
 56  
      */
 57  
     SignatureStatus finish()
 58  
         throws OpenPgpException, IOException;
 59  
 }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 
 22  
 /**
 23  
  * An interface for updating an OpenPGP signature on the fly with streaming data.
 24  
  *
 25  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 26  
  */
 27  
 public interface OpenPgpStreamingSignatureVerifier
 28  
 {
 29  
     String ROLE = OpenPgpStreamingSignatureVerifier.class.getName();
 30  
 
 31  
     /**
 32  
      * Update the signature with the next block from the data buffer.
 33  
      *
 34  
      * @param buf the buffer
 35  
      * @throws org.apache.commons.openpgp.OpenPgpException if the buffer is not valid for updating the signature
 36  
      */
 37  
     void update( byte[] buf )
 38  
         throws OpenPgpException;
 39  
 
 40  
     /**
 41  
      * Update the signature with the next block from the data buffer.
 42  
      *
 43  
      * @param buf    the buffer
 44  
      * @param offset offset within the buffer to start from
 45  
      * @param length number of bytes in the buffer to read from
 46  
      * @throws org.apache.commons.openpgp.OpenPgpException if the buffer is not valid for updating the signature
 47  
      */
 48  
     void update( byte[] buf, int offset, int length )
 49  
         throws OpenPgpException;
 50  
 
 51  
     /**
 52  
      * Finish and verify the signature that has been obtained.
 53  
      *
 54  
      * @return the status of the signature
 55  
      * @throws org.apache.commons.openpgp.OpenPgpException if the signature is not in a consistent or complete state
 56  
      */
 57  
     SignatureStatus finish()
 58  
         throws OpenPgpException, IOException;
 59  
 }
- + - + \ No newline at end of file Modified: websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSigner.html ============================================================================== --- websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSigner.html (original) +++ websites/production/commons/content/sandbox/commons-openpgp/cobertura/org.apache.commons.openpgp.OpenPgpStreamingSigner.html Sat Aug 10 22:25:17 2013 @@ -12,131 +12,131 @@
 
- - +
Classes in this File Line Coverage Branch Coverage Complexity
OpenPgpStreamingSigner
N/A
N/A
1
OpenPgpStreamingSigner$1
0%
0/1
N/A
1
OpenPgpStreamingSigner
N/A
N/A
1
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 
 22  
 /**
 23  
  * An interface for updating an OpenPGP signature on the fly with streaming data.
 24  
  *
 25  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 26  
  */
 27  
 public interface OpenPgpStreamingSigner
 28  
 {
 29  0
     String ROLE = OpenPgpStreamingSigner.class.getName();
 30  
 
 31  
     /**
 32  
      * Update the signature with the next block from the data buffer.
 33  
      *
 34  
      * @param buf the buffer
 35  
      * @throws OpenPgpException if the buffer is not valid for updating the signature
 36  
      */
 37  
     void update( byte[] buf )
 38  
         throws OpenPgpException;
 39  
 
 40  
     /**
 41  
      * Update the signature with the next block from the data buffer.
 42  
      *
 43  
      * @param buf    the buffer
 44  
      * @param offset offset within the buffer to start from
 45  
      * @param length number of bytes in the buffer to read from
 46  
      * @throws OpenPgpException if the buffer is not valid for updating the signature
 47  
      */
 48  
     void update( byte[] buf, int offset, int length )
 49  
         throws OpenPgpException;
 50  
 
 51  
     /**
 52  
      * Finish creating the signature.
 53  
      *
 54  
      * @return the completed signature
 55  
      * @throws OpenPgpException if the signature is not in a consistent or complete state
 56  
      */
 57  
     byte[] finish()
 58  
         throws OpenPgpException, IOException;
 59  
 }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 1  
 package org.apache.commons.openpgp;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 5  
  * contributor license agreements.  See the NOTICE file distributed with
 6  
  * this work for additional information regarding copyright ownership.
 7  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 8  
  * (the "License"); you may not use this file except in compliance with
 9  
  * the License.  You may obtain a copy of the License at
 10  
  *
 11  
  *      http://www.apache.org/licenses/LICENSE-2.0
 12  
  *
 13  
  * Unless required by applicable law or agreed to in writing, software
 14  
  * distributed under the License is distributed on an "AS IS" BASIS,
 15  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 16  
  * See the License for the specific language governing permissions and
 17  
  * limitations under the License.
 18  
  */
 19  
 
 20  
 import java.io.IOException;
 21  
 
 22  
 /**
 23  
  * An interface for updating an OpenPGP signature on the fly with streaming data.
 24  
  *
 25  
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 26  
  */
 27  
 public interface OpenPgpStreamingSigner
 28  
 {
 29  
     String ROLE = OpenPgpStreamingSigner.class.getName();
 30  
 
 31  
     /**
 32  
      * Update the signature with the next block from the data buffer.
 33  
      *
 34  
      * @param buf the buffer
 35  
      * @throws OpenPgpException if the buffer is not valid for updating the signature
 36  
      */
 37  
     void update( byte[] buf )
 38  
         throws OpenPgpException;
 39  
 
 40  
     /**
 41  
      * Update the signature with the next block from the data buffer.
 42  
      *
 43  
      * @param buf    the buffer
 44  
      * @param offset offset within the buffer to start from
 45  
      * @param length number of bytes in the buffer to read from
 46  
      * @throws OpenPgpException if the buffer is not valid for updating the signature
 47  
      */
 48  
     void update( byte[] buf, int offset, int length )
 49  
         throws OpenPgpException;
 50  
 
 51  
     /**
 52  
      * Finish creating the signature.
 53  
      *
 54  
      * @return the completed signature
 55  
      * @throws OpenPgpException if the signature is not in a consistent or complete state
 56  
      */
 57  
     byte[] finish()
 58  
         throws OpenPgpException, IOException;
 59  
 }
- + - + \ No newline at end of file