package c.t.s.xfire;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import javax.wsdl.PortType;
import javax.xml.namespace.QName;

/**
 * Contains information required for defining <code>partnerLinkType</code>
 * elements as part of a WSDL definition. 
 *  
 * The partnerLinkType XML schema is at
 * <a href="http://schemas.xmlsoap.org/ws/2003/05/partner-link/">
 * http://schemas.xmlsoap.org/ws/2003/05/partner-link/</a>.
 *  
 * @author deanj
 */
public class PartnerLinkType {

	// contains the roles defined for this element
	private final Set<Role> _roles;
	
	// the name of the partnerLinkType element
	private final String _name;
	
	/**
	 * Constructor.
	 */
	public PartnerLinkType(String name) {
		_roles = new HashSet<Role>();
		_name = name;
	}
	
	/**
	 * Add a role to the <code>partnerLinkType</code>.
	 * 
	 * @param roleName the value of the <code>name</code> attribute
	 * of the <code>role</code> element
	 * @param portType The PortType that this partnerLinkType refers to.
	 * of the <code>portType</code> element
	 * @throws IllegalStateException if there are already two
	 * roles defined for this <code>partnerLinkType</code>
	 */
	public void addRole(String roleName, PortType portType) {
		if (_roles.size()==2) {
			throw new IllegalStateException("Cannot add a role to a partnerLinkType that already has two roles defined");
		} else {
			_roles.add(new Role(roleName, portType));
		}
	}
	
	/**
	 * Retrieve the roles defined on this
	 * <code>partnerLinkType</code>. Note that this
	 * method makes a defensive unmodifiable copy of the 
	 * roles stored by this object (this ensures that the
	 * restriction on the allowed number of roles cannot
	 * be broken). 
	 * 
	 * @return an Iterator over the roles (at most two).
	 */
	public Set<Role> getRoles() {
		return Collections.unmodifiableSet(_roles);
	}

	/**
	 * Retrieve the name of the <code>partnerLinkType</code> element
	 * 
	 * @return the value of the <code>name</code> attribute 
	 * of the <code>partnerLinkType</code> element
	 */
	public String getName() {
		return _name;
	}
	
	/**
	 * Represents a role child element of a 
	 * <code>PartnerLinkType</code> element.
	 *  
	 * @author deanj
	 */
	public class Role {
		
		private final String _roleName;
		private final QName _portTypeName;
		
		/**
		 * Constructor.
		 * 
		 * @param roleName the value of the <code>name</code> attribute of the <code>role</code> element
		 * @param portType the <code>PortType</code> that this Role relates to, populates the value of the <code>name</code> 
		 *                 attribute of the <code>portType<code> element
		 */
		public Role(String roleName, PortType portType) {
			_portTypeName = portType.getQName();
			_roleName = roleName;
		}
		
		/**
		 * Getter for the name of the role
		 * 
		 * @return the name of the role
		 */
		public String getName() {
			return _roleName;
		}
		
		/**
		 * Getter for the qname of the port type
		 * 
		 * @return the qname of the port type
		 */
		public QName getPortTypeName() {
			return _portTypeName;
		}
	}
}