001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.jmx;
018
019import java.util.Objects;
020
021import javax.management.ObjectName;
022
023import org.apache.logging.log4j.core.selector.ContextSelector;
024
025/**
026 * Implementation of the {@code ContextSelectorAdminMBean} interface.
027 */
028public class ContextSelectorAdmin implements ContextSelectorAdminMBean {
029
030    private final ObjectName objectName;
031    private final ContextSelector selector;
032
033    /**
034     * Constructs a new {@code ContextSelectorAdmin}.
035     *
036     * @param contextName name of the LoggerContext under which to register this
037     *            ContextSelectorAdmin. Note that the ContextSelector may be
038     *            registered multiple times, once for each LoggerContext. In web
039     *            containers, each web application has its own LoggerContext and
040     *            by associating the ContextSelector with the LoggerContext, all
041     *            associated MBeans can be unloaded when the web application is
042     *            undeployed.
043     * @param selector the instrumented object
044     */
045    public ContextSelectorAdmin(final String contextName, final ContextSelector selector) {
046        this.selector = Objects.requireNonNull(selector, "ContextSelector");
047        try {
048            final String mbeanName = String.format(PATTERN, Server.escape(contextName));
049            objectName = new ObjectName(mbeanName);
050        } catch (final Exception e) {
051            throw new IllegalStateException(e);
052        }
053    }
054
055    /**
056     * Returns the {@code ObjectName} of this mbean.
057     *
058     * @return the {@code ObjectName}
059     * @see ContextSelectorAdminMBean#PATTERN
060     */
061    public ObjectName getObjectName() {
062        return objectName;
063    }
064
065    @Override
066    public String getImplementationClassName() {
067        return selector.getClass().getName();
068    }
069}