/**
* Copyright (c) 2005-2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* WSO2 Inc. 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.message.processor.impl.failover;
import java.util.List;
public interface FailoverMessageForwardingProcessorViewMBean {
/**
* try resending all messages stored in the message store.
*/
public void resendAll() throws Exception;
/**
* Delete all the Messages in Message store
*/
public void deleteAll() throws Exception;
/**
* Get the Message IDs of all stored Messages in the Message store
*
* @return a list of message ID values
*/
public List<String> messageIdList() throws Exception;
/**
* Resend the Message with the given id
* return false if fail to re try deliver the message
*
* @param messageID ID of the message to be resent
* @return true if the resend operation was successful and false otherwise
*/
public void resend(String messageID) throws Exception;
/**
* Delete the Message with Given id
*
* @param messageID ID of the message to be deleted
*/
public void delete(String messageID) throws Exception;
/**
* Get the SOAP envelope of the given Message with given ID
*
* @param messageID ID of the message to be returned
* @return the SOAP envelope content as a string
*/
public String getEnvelope(String messageID) throws Exception;
/**
*
* @return the number of Messages stored in the store.
*/
public int getSize();
/**
* Get the Status of the Message Processor
* @return status of the Processor
*/
public boolean isActive();
/**
* Activate the Message Processor.
* This will resume processing the Messages if its in deactivated state and
* reset the Send attempt count.
*/
public void activate();
/**
* Deactivate the Message Processor
* This will stop the processing of Messages.
*/
public void deactivate();
}