001/*
002 * Copyright 2009 Red Hat, Inc.
003 * Red Hat licenses this file to you under the Apache License, version
004 * 2.0 (the "License"); you may not use this file except in compliance
005 * with the License.  You may obtain a copy of the License at
006 *    http://www.apache.org/licenses/LICENSE-2.0
007 * Unless required by applicable law or agreed to in writing, software
008 * distributed under the License is distributed on an "AS IS" BASIS,
009 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
010 * implied.  See the License for the specific language governing
011 * permissions and limitations under the License.
012 */
013
014package org.hornetq.api.core.management;
015
016/**
017 * A DivertControl is used to manage a divert.
018 * 
019 * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a>
020 */
021public interface DivertControl
022{
023   /**
024    * Returns the filter used by this divert.
025    */
026   String getFilter();
027
028   /**
029    * Returns whether this divert is exclusive.
030    * <br>
031    * if {@code true} messages will be exclusively diverted and will not be routed to the origin address,
032    * else messages will be routed both to the origin address and the forwarding address.
033    */
034   boolean isExclusive();
035
036   /**
037    * Returns the cluster-wide unique name of this divert.
038    */
039   String getUniqueName();
040
041   /**
042    * Returns the routing name of this divert.
043    */
044   String getRoutingName();
045
046   /**
047    * Returns the origin address used by this divert.
048    */
049   String getAddress();
050
051   /**
052    * Returns the forwarding address used by this divert.
053    */
054   String getForwardingAddress();
055
056   /**
057    * Return the name of the org.hornetq.core.server.cluster.Transformer implementation associated to this bridge.
058    */
059   String getTransformerClassName();
060}