XMPPServerConnectorRegistry.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.vysper.xmpp.server.s2s;

import org.apache.vysper.xmpp.addressing.Entity;
import org.apache.vysper.xmpp.delivery.failure.RemoteServerNotFoundException;
import org.apache.vysper.xmpp.delivery.failure.RemoteServerTimeoutException;
import org.apache.vysper.xmpp.protocol.SessionStateHolder;
import org.apache.vysper.xmpp.server.SessionContext;

/**
 * Registry for {@link XMPPServerConnector} for external XMPP servers. 
 *  
 * @author The Apache MINA Project (dev@mina.apache.org)
 */
public interface XMPPServerConnectorRegistry {

    /**
     * Connects or reuses an existing connection to an external XMPP server.
     * 
     * @param server The domain name of the external XMPP server
     * @return An {@link XMPPServerConnector} for writing stanzas for the external server
     * @throws RemoteServerNotFoundException
     * @throws RemoteServerTimeoutException
     */
    XMPPServerConnector connect(Entity server) throws RemoteServerNotFoundException,
            RemoteServerTimeoutException;

    /**
     * Connects to an external XMPP server for server dialback processing.
     * 
     * @param server The domain name of the external XMPP server
     * @param sessionContext The {@link SessionContext} for the original connection that is being 
     *  authenticated using server dialback
     * @param sessionStateHolder The {@link SessionStateHolder} for the original connection that is being 
     *  authenticated using server dialback
     * @return An {@link XMPPServerConnector} for server dialback
     * @throws RemoteServerNotFoundException
     * @throws RemoteServerTimeoutException
     */
    XMPPServerConnector connectForDialback(Entity server, SessionContext sessionContext, SessionStateHolder sessionStateHolder) throws RemoteServerNotFoundException,
    RemoteServerTimeoutException;

    void close();

}