/*
 * Copyright 2017, TeamDev Ltd. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.spine3.server.command;

import org.spine3.Internal;
import org.spine3.base.CommandClass;
import org.spine3.base.CommandEnvelope;

import java.util.Set;

/**
 * A common interface for objects which need to dispatch the
 * {@linkplain org.spine3.base.Command commands}, but are unable to implement
 * the {@link org.spine3.server.command.CommandDispatcher CommandDispatcher} directly.
 *
 * @author Alex Tymchenko
 * @see DelegatingCommandDispatcher
 */
@Internal
public interface CommandDispatcherDelegate {

    Set<CommandClass> getCommandClasses();

    void dispatchCommand(CommandEnvelope envelope);
}

/*
 * Copyright 2017, TeamDev Ltd. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.spine3.server.command;

import org.spine3.Internal;
import org.spine3.base.CommandClass;
import org.spine3.base.CommandEnvelope;

import java.util.Set;

/**
 * A common interface for objects which need to dispatch the
 * {@linkplain org.spine3.base.Command commands}, but are unable to implement
 * the {@linkplain org.spine3.server.command.CommandDispatcher CommandDispatcher}.
 *
 * <p>A typical example of a {@code CommandDispatcherDelegate} usage is a routine, which
 * simultaneously dispatches different types of {@linkplain com.google.protobuf.Message messages}
 * in addition to {@code Command}s.
 *
 * <p>In this case such a class would have to implement several
 * {@linkplain org.spine3.server.bus.MessageDispatcher MessageDispatcher} child interfaces
 * (such as {@linkplain org.spine3.server.command.CommandDispatcher CommandDispatcher} or
 * {@linkplain org.spine3.server.event.EventDispatcher EventDispatcher}). However, it is impossible
 * to implement the same {@link org.spine3.server.bus.MessageDispatcher#getMessageClasses()
 * getMessageClasses()} method several times with the different types of {@code MessageClass}es
 * returned.
 *
 * <p>The same interference takes place in attempt to implement
 * {@link org.spine3.server.bus.MessageDispatcher#dispatch(org.spine3.base.MessageEnvelope)
 * MessageDispatcher#dispatch(MessageEnvelope)} method with the different types of
 * {@code MessageEnvelope}s dispatches simultaneously.
 *
 * <p>That's why unlike {@linkplain org.spine3.server.bus.MessageDispatcher MessageDispatcher},
 * this interface defines its own contract for declaring the dispatched
 * {@linkplain CommandClass command classes}, which does not interfere with the
 * {@code MessageDispatcher} API.
 *
 * @author Alex Tymchenko
 * @see DelegatingCommandDispatcher
 */
@Internal
public interface CommandDispatcherDelegate {

    Set<CommandClass> getCommandClasses();

    void dispatchCommand(CommandEnvelope envelope);
}

Clarify the purpose of `CommandDispatcherDelegate`.