Source for javax.naming.ldap.StartTlsRequest

   1: /* StartTlsRequest.java -- extended ldap TLS request
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.naming.ldap;
  40: 
  41: import java.util.Iterator;
  42: 
  43: import gnu.classpath.ServiceFactory;
  44: 
  45: import javax.naming.NamingException;
  46: 
  47: /**
  48:  * @since 1.4
  49:  */
  50: public class StartTlsRequest
  51:     implements ExtendedRequest
  52: {
  53:   private static final long serialVersionUID = 4441679576360753397L;
  54: 
  55:   /**
  56:    * The assigned object identifier for this response.
  57:    */
  58:   public static final String OID = "1.3.6.1.4.1.1466.20037";
  59: 
  60:   /**
  61:    * Create a new instance.
  62:    */
  63:   public StartTlsRequest()
  64:   {
  65:   }
  66: 
  67:   /**
  68:    * Return the response identifier.  This is simply the value
  69:    * of the {@link #OID} field.
  70:    */
  71:   public String getID()
  72:   {
  73:     return OID;
  74:   }
  75: 
  76:   /**
  77:    * Return the encoded value.  This implementation always returns null.
  78:    */
  79:   public byte[] getEncodedValue()
  80:   {
  81:     return null;
  82:   }
  83: 
  84:   /**
  85:    * Create a new extended reponse object, using the standard service
  86:    * provider approach to load a provider.  The provider will be a subclass
  87:    * of StartTlsRequest with a no-argument constructor.  The key is
  88:    * "javax.naming.ldap.StartTlsRequest".
  89:    * @param id the identifier, must be {@link #OID} or null
  90:    * @param berValue ignored
  91:    * @param offset ignored
  92:    * @param length ignored
  93:    * @throws NamingException if there is a problem creating the response
  94:    */
  95:   public ExtendedResponse createExtendedResponse(String id, byte[] berValue,
  96:                                                  int offset, int length)
  97:       throws NamingException
  98:   {
  99:     if (id != null && ! OID.equals(id))
 100:       throw new NamingException("incorrect id: was \"" + id
 101:                                 + "\", but expected: \"" + OID + "\"");
 102:     Iterator it = ServiceFactory.lookupProviders(StartTlsRequest.class);
 103:     if (it.hasNext())
 104:       return (ExtendedResponse) it.next();
 105:     throw new NamingException("couldn't find provider for "
 106:                               + "javax.naming.ldap.StartTlsRequest");
 107:   }
 108: }