001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.types; 028 029 030 031 /** 032 * This enumeration defines the set of possible authentication types 033 * that may be used for a bind request. This is based on the LDAP 034 * specification defined in RFC 2251. 035 */ 036 @org.opends.server.types.PublicAPI( 037 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 038 mayInstantiate=false, 039 mayExtend=false, 040 mayInvoke=true) 041 public enum AuthenticationType 042 { 043 /** 044 * The authentication type that indicates that the user will be 045 * performing simple authentication (i.e., just a password). 046 */ 047 SIMPLE((byte) 0x80), 048 049 050 051 /** 052 * The authentication type that indicates that the user will be 053 * performing SASL authentication using some extensible mechanism. 054 */ 055 SASL((byte) 0xA3), 056 057 058 059 /** 060 * The authentication type that indicates that the associated 061 * connection is an internal connection. 062 */ 063 INTERNAL((byte) 0xFF); 064 065 066 067 // The BER type tag that is associated with this authentication 068 // type. 069 private byte berType; 070 071 072 073 /** 074 * Creates a new authentication type with the provided BER type tag. 075 * 076 * @param berType The BER type tag that is associated with this 077 * authentication type. 078 */ 079 private AuthenticationType(byte berType) 080 { 081 this.berType = berType; 082 } 083 084 085 086 /** 087 * Retrieves the BER type tag associated with this authentication 088 * type. 089 * 090 * @return The BER type tag associated with this authentication 091 * type. 092 */ 093 public int getBERType() 094 { 095 return berType; 096 } 097 098 099 100 /** 101 * Retrieves a string representation of this authentication type. 102 * 103 * @return A string representation of this authentication type. 104 */ 105 public String toString() 106 { 107 switch (berType) 108 { 109 case (byte) 0x80: 110 return "Simple"; 111 case (byte) 0xA3: 112 return "SASL"; 113 case (byte) 0xFF: 114 return "Internal"; 115 default: 116 return "Unknown"; 117 } 118 } 119 } 120