001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jmx.support;
018
019/**
020 * Indicates registration behavior when attempting to register an MBean that already
021 * exists.
022 *
023 * @author Phillip Webb
024 * @author Chris Beams
025 * @since 3.2
026 */
027public enum RegistrationPolicy {
028
029        /**
030         * Registration should fail when attempting to register an MBean under a name that
031         * already exists.
032         */
033        FAIL_ON_EXISTING,
034
035        /**
036         * Registration should ignore the affected MBean when attempting to register an MBean
037         * under a name that already exists.
038         */
039        IGNORE_EXISTING,
040
041        /**
042         * Registration should replace the affected MBean when attempting to register an MBean
043         * under a name that already exists.
044         */
045        REPLACE_EXISTING;
046
047        /**
048         * Translate from an {@link MBeanRegistrationSupport} registration behavior constant
049         * to a {@link RegistrationPolicy} enum value.
050         * @param registrationBehavior one of the now-deprecated REGISTRATION_* constants
051         * available in {@link MBeanRegistrationSupport}.
052         */
053        @SuppressWarnings("deprecation")
054        static RegistrationPolicy valueOf(int registrationBehavior) {
055                switch (registrationBehavior) {
056                        case MBeanRegistrationSupport.REGISTRATION_IGNORE_EXISTING:
057                                return RegistrationPolicy.IGNORE_EXISTING;
058                        case MBeanRegistrationSupport.REGISTRATION_REPLACE_EXISTING:
059                                return RegistrationPolicy.REPLACE_EXISTING;
060                        case MBeanRegistrationSupport.REGISTRATION_FAIL_ON_EXISTING:
061                                return RegistrationPolicy.FAIL_ON_EXISTING;
062                }
063                throw new IllegalArgumentException(
064                                "Unknown MBean registration behavior: " + registrationBehavior);
065        }
066
067}