com.alogient.cameleon.sdk.community.interspire.InterspireConnectorHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cameleon4java-sdk Show documentation

The newest version!

package com.alogient.cameleon.sdk.community.interspire;

import com.alogient.cameleon.sdk.community.interspire.request.ISubscribersRequest;
import com.alogient.cameleon.sdk.community.interspire.request.IUnSubscribersRequest;
import com.alogient.cameleon.sdk.community.interspire.request.impl.CreateSubscribersRequest;
import com.alogient.cameleon.sdk.community.interspire.request.impl.CreateUnSubscribersRequest;

/**
 * Helper class used to send specific requests to Inspire.
 * 
 * To use the interspire connector helper, you need first to call one of the
 * static methods. Once the attributes are set, you just need to call the
 * send method defined into the IRequest interface.
 *
 *
 * User: jmirc
 * Date: 27-Jan-2010
 * Time: 1:31:30 PM
 */
public class InterspireConnectorHelper {


    /**
     * Subscribe to a list
     * @param username the XML username
     * @param token the XML Api token
     * @param interspireURL the URL of the Interspire server
     * @return the XML request
     */
    public static ISubscribersRequest subscribeToListRequest(String username, 
            String token, String interspireURL) {
        return new CreateSubscribersRequest(username, token, interspireURL);
    }

    /**
     * Unsubscribe to a list
     */
    /**
     * Subscribe to a list
     * @param username the XML username
     * @param token the XML Api token
     * @param interspireURL the URL of the Interspire server
     * @return the XML request
     */
    public static IUnSubscribersRequest unSubscribeToListRequest(String username, 
            String token, String interspireURL) {
        return new CreateUnSubscribersRequest(username, token, interspireURL);
    }
}