SynapseArtifact.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.synapse;

/**
 * This is the super interface for all the artifacts defined in the
 * <code>SynapseConfiguration</code>. It defines the common API for all the synapse artifacts.
 */
public interface SynapseArtifact {

    /**
     * Set the description of the artifact
     *
     * @param description tobe set to the artifact
     */
    void setDescription(String description);

    /**
     * Retrieves the description of the artifact
     *
     * @return description of the artifact
     */
    String getDescription();
}