log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultAdvertiser.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache license, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the license for the specific language governing permissions and
 * limitations under the license.
 */
package org.apache.logging.log4j.core.config;

import java.util.Map;

import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.net.Advertiser;

/**
 * The default advertiser does not do anything.
 */
@Plugin(name = "default", category = Node.CATEGORY, elementType = "advertiser", printObject = false)
public class DefaultAdvertiser implements Advertiser {

    /**
     * Does nothing.
     *
     * @return null
     */
    @Override
    public Object advertise(final Map<String, String> properties) {
        return null;
    }

    /**
     * Does nothing.
     * @param advertisedObject
     */
    @Override
    public void unadvertise(final Object advertisedObject) {
        //no-op
    }

}