You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@santuario.apache.org by ra...@apache.org on 2005/04/02 20:43:01 UTC

cvs commit: xml-security/src/org/apache/xml/security/keys/keyresolver/implementations EncryptedKeyResolver.java

raul        2005/04/02 10:43:01

  Modified:    src/org/apache/xml/security/keys/keyresolver
                        KeyResolverSpi.java KeyResolver.java
               src/org/apache/xml/security/keys/storage
                        StorageResolverSpi.java StorageResolver.java
               src/org/apache/xml/security/keys/keyresolver/implementations
                        EncryptedKeyResolver.java
  Log:
  Fixed eclipse javadocs warning.
  
  Revision  Changes    Path
  1.11      +9 -9      xml-security/src/org/apache/xml/security/keys/keyresolver/KeyResolverSpi.java
  
  Index: KeyResolverSpi.java
  ===================================================================
  RCS file: /home/cvs/xml-security/src/org/apache/xml/security/keys/keyresolver/KeyResolverSpi.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- KeyResolverSpi.java	24 Sep 2004 20:54:28 -0000	1.10
  +++ KeyResolverSpi.java	2 Apr 2005 18:43:01 -0000	1.11
  @@ -53,7 +53,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return true if can resolve the key in the element
       */
      abstract public boolean engineCanResolve(Element element, String BaseURI,
                                               StorageResolver storage);
  @@ -64,7 +64,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolved public key from the registered from the element.
       * 
       * @throws KeyResolverException
       */
  @@ -78,7 +78,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolved X509Certificate key from the registered from the elements
       *
       * @throws KeyResolverException
       */
  @@ -92,7 +92,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolved SecretKey key from the registered from the elements
       *
       * @throws KeyResolverException
       */
  @@ -130,7 +130,7 @@
       * Method engineGetProperty
       *
       * @param key
  -    * @return
  +    * @return obtain the property appointed by key
       */
      public String engineGetProperty(String key) {
   
  @@ -152,7 +152,7 @@
      /**
       * Method engineGetPropertyKeys
       *
  -    * @return
  +    * @return the keys of properties known by this resolver
       */
      public String[] engineGetPropertyKeys() {
         return new String[0];
  @@ -162,7 +162,7 @@
       * Method understandsProperty
       *
       * @param propertyToTest
  -    * @return
  +    * @return true if understood the property
       */
      public boolean understandsProperty(String propertyToTest) {
   
  
  
  
  1.12      +13 -13    xml-security/src/org/apache/xml/security/keys/keyresolver/KeyResolver.java
  
  Index: KeyResolver.java
  ===================================================================
  RCS file: /home/cvs/xml-security/src/org/apache/xml/security/keys/keyresolver/KeyResolver.java,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- KeyResolver.java	23 Mar 2005 18:14:54 -0000	1.11
  +++ KeyResolver.java	2 Apr 2005 18:43:01 -0000	1.12
  @@ -74,7 +74,7 @@
      /**
       * Method length
       *
  -    * @return
  +    * @return the length of resolvers registed
       */
      public static int length() {
         return KeyResolver._resolverVector.size();
  @@ -84,7 +84,7 @@
       * Method item
       *
       * @param i
  -    * @return
  +    * @return the number i resolver registerd
       * @throws KeyResolverException
       */
      public static KeyResolver item(int i) throws KeyResolverException {
  @@ -103,7 +103,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return the instance that happends to implement the thing.
       * 
       * @throws KeyResolverException
       */
  @@ -193,7 +193,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolve from the static register an element
       * 
       * @throws KeyResolverException
       */
  @@ -212,8 +212,8 @@
       *
       * @param element
       * @param BaseURI
  -    * @param storage
  -    * @return
  +    * @param storage 
  +    * @return resolved public key from the registered from the elements
       * 
       * @throws KeyResolverException
       */
  @@ -229,7 +229,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolved X509certificate key from the registered from the elements
       * 
       * @throws KeyResolverException
       */
  @@ -244,7 +244,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return resolved SecretKey key from the registered from the elements
       * @throws KeyResolverException
       */
      public SecretKey resolveSecretKey(
  @@ -268,7 +268,7 @@
       * Method getProperty
       *
       * @param key
  -    * @return
  +    * @return the property setted for this resolver
       */
      public String getProperty(String key) {
         return this._resolverSpi.engineGetProperty(key);
  @@ -277,7 +277,7 @@
      /**
       * Method getPropertyKeys
       *
  -    * @return
  +    * @return the properties key registerd in this resolver
       */
      public String[] getPropertyKeys() {
         return this._resolverSpi.engineGetPropertyKeys();
  @@ -287,7 +287,7 @@
       * Method understandsProperty
       *
       * @param propertyToTest
  -    * @return
  +    * @return true if the resolver understands property propertyToTest
       */
      public boolean understandsProperty(String propertyToTest) {
         return this._resolverSpi.understandsProperty(propertyToTest);
  @@ -299,7 +299,7 @@
       * @param element
       * @param BaseURI
       * @param storage
  -    * @return
  +    * @return true if can resolve the key in the element
       */
      public boolean canResolve(Element element, String BaseURI,
                                StorageResolver storage) {
  @@ -309,7 +309,7 @@
      /**
       * Method resolverClassName
       *
  -    * @return
  +    * @return the name of the resolver.
       */
      public String resolverClassName() {
         return this._resolverSpi.getClass().getName();
  
  
  
  1.5       +2 -2      xml-security/src/org/apache/xml/security/keys/storage/StorageResolverSpi.java
  
  Index: StorageResolverSpi.java
  ===================================================================
  RCS file: /home/cvs/xml-security/src/org/apache/xml/security/keys/storage/StorageResolverSpi.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- StorageResolverSpi.java	24 Sep 2004 20:54:28 -0000	1.4
  +++ StorageResolverSpi.java	2 Apr 2005 18:43:01 -0000	1.5
  @@ -31,7 +31,7 @@
      /**
       * Method getIterator
       *
  -    * @return
  +    * @return the iterator for the storage
       */
      public abstract Iterator getIterator();
   }
  
  
  
  1.10      +4 -4      xml-security/src/org/apache/xml/security/keys/storage/StorageResolver.java
  
  Index: StorageResolver.java
  ===================================================================
  RCS file: /home/cvs/xml-security/src/org/apache/xml/security/keys/storage/StorageResolver.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- StorageResolver.java	23 Mar 2005 18:14:54 -0000	1.9
  +++ StorageResolver.java	2 Apr 2005 18:43:01 -0000	1.10
  @@ -116,7 +116,7 @@
   
      /**
       * Method getIterator
  -    * @return
  +    * @return the iterator for the resolvers.
       *
       */
      public Iterator getIterator() {
  @@ -131,7 +131,7 @@
      /**
       * Method hasNext
       *
  -    * @return
  +    * @return true if there is more elements.
       */
      public boolean hasNext() {
   
  @@ -145,7 +145,7 @@
      /**
       * Method next
       *
  -    * @return
  +    * @return the next element
       */
      public X509Certificate next() {
         return (X509Certificate) this._iterator.next();
  
  
  
  1.6       +1 -1      xml-security/src/org/apache/xml/security/keys/keyresolver/implementations/EncryptedKeyResolver.java
  
  Index: EncryptedKeyResolver.java
  ===================================================================
  RCS file: /home/cvs/xml-security/src/org/apache/xml/security/keys/keyresolver/implementations/EncryptedKeyResolver.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- EncryptedKeyResolver.java	25 Sep 2004 19:42:22 -0000	1.5
  +++ EncryptedKeyResolver.java	2 Apr 2005 18:43:01 -0000	1.6
  @@ -86,7 +86,7 @@
   	 * @param element
   	 * @param BaseURI
   	 * @param storage
  -	 * @return
  +	 * @return true if can resolve the key in the element
   	 *
   	 */