001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.shared.ldap.extras.controls; 021 022/** 023 * This class describes the four possible synchronization mode, out of 024 * which only two are presently valid : 025 * 026 * syncRequestValue ::= SEQUENCE { 027 * mode ENUMERATED { 028 * -- 0 unused 029 * refreshOnly (1), 030 * -- 2 reserved 031 * refreshAndPersist (3) 032 * ... 033 * 034 * @see <a href="http://www.faqs.org/rfcs/rfc4533.html">RFC 4533</a> 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 * 037 */ 038public enum SynchronizationModeEnum 039{ 040 UNUSED(0), 041 REFRESH_ONLY(1), 042 RESERVED(2), 043 REFRESH_AND_PERSIST(3); 044 045 /** The internal value */ 046 private int value; 047 048 049 /** 050 * Private constructor so no other instances can be created other than the 051 * public static constants in this class. 052 * 053 * @param value the integer value of the enumeration. 054 */ 055 private SynchronizationModeEnum( int value ) 056 { 057 this.value = value; 058 } 059 060 061 /** 062 * @return The value associated with the current element. 063 */ 064 public int getValue() 065 { 066 return value; 067 } 068 069 070 /** 071 * Get the {@link SynchronizationModeEnum} instance from an integer value. 072 * 073 * @param value The value we want the enum element from 074 * @return The enum element associated with this integer 075 */ 076 public static SynchronizationModeEnum getSyncMode( int value ) 077 { 078 if ( value == REFRESH_AND_PERSIST.getValue() ) 079 { 080 return REFRESH_AND_PERSIST; 081 } 082 else if ( value == REFRESH_ONLY.getValue() ) 083 { 084 return REFRESH_ONLY; 085 } 086 else if ( value == UNUSED.getValue() ) 087 { 088 return UNUSED; 089 } 090 else 091 { 092 return RESERVED; 093 } 094 } 095}