IdentityService.java

/* ==================================================================
 * IdentityService.java - Feb 24, 2011 4:05:38 PM
 * 
 * Copyright 2007-2011 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 * $Id$
 * ==================================================================
 */

package net.solarnetwork.node;

import java.security.Principal;

/**
 * API for knowing information about the node's identity.
 * 
 * @author matt
 * @version 1.1
 */
public interface IdentityService {

	/**
	 * Get the ID of the current node.
	 * 
	 * @return node ID, or <em>null</em> if the ID is not known
	 */
	Long getNodeId();

	/**
	 * Get a {@link Principal} for the current node.
	 * 
	 * @return The node Principal, or <em>null</em> if none available.
	 */
	Principal getNodePrincipal();

	/**
	 * Get the host name for the SolarNet central service.
	 * 
	 * @return a host name
	 */
	String getSolarNetHostName();

	/**
	 * Get the host port for the SolarNet central service.
	 * 
	 * @return a host name
	 */
	Integer getSolarNetHostPort();

	/**
	 * Get the URL prefix for the SolarIn service.
	 * 
	 * @return a URL prefix
	 */
	String getSolarNetSolarInUrlPrefix();

	/**
	 * Return an absolute URL to the SolarIn service.
	 * 
	 * <p>
	 * This is a convenience method for generating a URL for the correct
	 * SolarNet host, SolarNet port, and SolarIn URL prefix as a single absolute
	 * URL string.
	 * </p>
	 * 
	 * @return SolarIn base URL
	 */
	String getSolarInBaseUrl();

}