InvitationSender.java

/*
 *  Copyright 2014 Eric F. Savage, code@efsavage.com
 *
 *   Licensed 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 com.ajah.user.invitation;

import com.ajah.user.User;
import com.ajah.user.info.UserInfo;

/**
 * Interface for mechanisms that construct and deliver invitations via the
 * appropriate channel.
 * 
 * @author <a href="http://efsavage.com">Eric F. Savage</a>, <a
 *         href="mailto:code@efsavage.com">code@efsavage.com</a>.
 * 
 */
public interface InvitationSender {

	/**
	 * Sends an invitation across the configured channel(s).
	 * 
	 * @param invitation
	 *            The invitation to send.
	 * @param user
	 *            The user sending the invitation.
	 * @param userInfo
	 *            Additional information about the sender.
	 */
	void send(final Invitation invitation, final User user, final UserInfo userInfo);

}