subnetworkconnection.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

   * Modes Of Operation</a> for details.<br>
   * The sncState is an attribute managed by the EMS.<br>
   * The EMS manages the state transition of this attribute.<br>
   * The EMS will assess the cross-connections in the network that
   * support the SNC and will appropriately adjust the value of SNCState to 
   * reflect the actual state of the SNC in the network.
   * </dir>
   *
   * globaldefs ::ConnectionDirection_T <b>direction</b>:
   * <dir>Specifies the direction of the
   * subnetwork connection.
   * It is a readonly attribute.</dir>
   *
   * transmissionParameters::LayerRate_T <b>rate</b>:
   * <dir>The rate of the SubnetworkConnection is obtained by reading
   * this attribute. The EMS sets this attribute at creation of the SNC.
   * The EMS is allowed to choose a Layer Rate equivalent to that of 
   * one of the TPs. The EMS is
   * expected to reflect any equivalent layer rate in any connection 
   * retrievals (i.e. the connection rate of the SNC retrieved from the 
   * EMS does not have to be the same as that requested by the NMS so long
   * as it is an equivalent rate).</dir>
   *
   * <dir>For a detailed description of the use of this attribute see 
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * This is a readonly attribute.</dir>
   *
   * StaticProtectionLevel_T <b>staticProtectionLevel</b>:
   * <dir>The static protection level of the SNC.  
   * For a detailed description of the use of this attribute, see 
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * This is a readonly attribute.</dir>
   *
   * SNCType_T <b>sncType</b>:
   * <dir>The type of the SNC.  For a detailed description of the use of this attribute, see 
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * This is a readonly attribute.</dir>
   *
   * TPDataList_T <b>aEnd</b>:
   * <dir>The list of Aend termination points where this SNC terminates.
   * For a detailed description of the use of this attribute, see 
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * This is a readonly attribute.</dir>
   *
   * TPDataList_T <b>zEnd</b>:
   * <dir>The list of Zend termination points where this SNC terminates.
   * For a detailed description of the use of this attribute, see 
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * This is a readonly attribute.</dir>
   *
   * Reroute_T <b>rerouteAllowed</b>:
   * <dir>This attribute specifies if the EMS is allowed/required to reroute this SNC.</dir>
   *
   * NetworkRouted_T <b>networkRouted</b>:
   * <dir>This attribute specifies if the route for this SNC is computed by the network.</dir>
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <dir>This attribute allows the communication from the EMS to the NMS of additional 
   * information which is not explicitly modelled.
   * It is a readonly attribute.</dir>
   * <br>
   **/
   struct SubnetworkConnection_T
   {
   globaldefs::NamingAttributes_T name;
   string userLabel;
   string nativeEMSName;
   string owner;
   SNCState_T sncState;    
   globaldefs::ConnectionDirection_T direction;
   transmissionParameters::LayerRate_T rate;
   StaticProtectionLevel_T staticProtectionLevel;
   SNCType_T sncType;
   TPDataList_T aEnd;    
   TPDataList_T zEnd;    
   Reroute_T rerouteAllowed;
   NetworkRouted_T networkRouted;
   globaldefs::NVSList_T additionalInfo;
  };


  /**
   * <p>Sequence of SubnetworkConnection_T.</p>
   **/
   typedef sequence<SubnetworkConnection_T> SubnetworkConnectionList_T;


  /**
   * <p>A crossConnect represents a connection within a single managed element.
   * This structure is primarily used in the specification of routes.</p>
   *
   * boolean <b>active</b>:
   * <dir>Indicates if the cross-connect is active in the ME.  Refer to
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a> for details.</dir>
   *
   * globaldefs::ConnectionDirection_T <b>direction</b>:
   * <dir>Directionality of the cross connection.</dir>
   *
   * SNCType_T <b>ccType</b>:
   * <dir>Type of connection as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</dir>
   *
   * globaldefs::NamingAttributesList_T <b>aEndNameList</b>:
   * <dir>Names of CTPs at the aEnd of the cross connection.</dir>
   *
   * globaldefs::NamingAttributesList_T <b>zEndNameList</b>:
   * <dir>Names of CTPs at the zEnd of the cross connection.</dir>
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <dir>This attribute allows the communication from the EMS to the NMS of additional 
   * information which is not explicitly modelled.
   * It is a readonly attribute.</dir>
   **/
  struct CrossConnect_T
  {
   boolean active;
   globaldefs::ConnectionDirection_T direction; 
   SNCType_T ccType;
   globaldefs::NamingAttributesList_T aEndNameList;
   globaldefs::NamingAttributesList_T zEndNameList;
   globaldefs::NVSList_T additionalInfo;
  };


  /**
   * <p>A route for an SNC is defined as a partially ordered list of cross-connects.</p>
   *
   * <p>This structure can deal with any arbitrarily complex protection paths
   * made up from connection types described in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</p>
   * 
   * <p>The cross-connects are listed from the NE 
   * on which the SNC starts (first entry) to the NE on which the SNC ends
   * (last entry) and the aEndNameList and zEndNameList will name CTPs of the
   * same or equivalent layerRate only. There is no mandatory order in
   * the cross-connects listed in between the first one and the last one.</p>
   **/
   typedef sequence<CrossConnect_T> Route_T;


  /**
   * <p>Arbitrary sequence of cross-connects.</p>
   **/
   typedef sequence<CrossConnect_T> CrossConnectList_T;


  /**
   * <p>An inclusion/exclusion constraint for an SNC is defined as a list of resources.
   * A resource is defined as an ME, TL, CTP, PTP, or SNC.</p>
   */
   typedef globaldefs::NamingAttributes_T Resource_T;


  /**
   * <p>Set of Resources_T, used as an inclusion/exclusion constraint for SNC creation.</p>
   *
   * <p>There is no mandatory order for the resources listed.</p>
   */
   typedef sequence<Resource_T> ResourceList_T;


  /**
   * <p>In order to allow the NMS to deal with a large number of objects,
   * iterators are used.</p>
   * <p>See <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   **/

   interface CCIterator_I 
    {
	boolean  next_n(in  unsigned long    how_many,
			out CrossConnectList_T ccList)
		 raises (globaldefs::ProcessingFailureException);

	unsigned long getLength()
		 raises (globaldefs::ProcessingFailureException);

	void     destroy()
		 raises (globaldefs::ProcessingFailureException);
    };


  /**
   * <p>The read-create attributes required for the creation of a
   * subnetworkConnection on the EMS are packaged together in an SNCCreateData
   * structure which the NMS will pass to the EMS at SNC creation time.  These 
   * are the read-create attributes of the SNC.</p>
   *
   * string <b>userLabel</b>:
   * <dir>userLabel may be specified by the NMS. May be empty.</dir>
   *
   * boolean <b>forceUniqueness</b>:
   * <dir>Specifies whether uniqueness of the userLabel is required amongst SNCs of 
   *  the EMS.  The operation will fail if userLabel is already in use.</dir>
   *
   * string <b>owner</b>:
   * <dir>owner may be specified by the NMS. May be empty.</dir>
   *
   * Globaldefs::ConnectionDirection_T <b>direction</b>:
   * <dir>The connection directionality must be specified by the NMS.</dir>
   *
   * StaticProtectionLevel_T <b>staticProtectionLevel</b>:
   * <dir>The NMS must specify the requested staticProtectionLevel as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</dir>
   *
   * ProtectionEffort_T <b>protectionEffort</b>:
   * <dir>The NMS must specify the protectionEffort as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</dir>
   *
   * Reroute_T <b>rerouteAllowed</b>:
   * <dir>This attribute specifies if the EMS is allowed/required to reroute this SNC.
   * There is no requirement for the reroutes
   * to respect the constraints specified in the creation request
   * (ccInclusions, neTpInclusions, fullRoute, neTpSncExclusions).</dir>
   *
   * NetworkRouted_T <b>networkRouted</b>:
   * <dir>This attribute specifies if the network is allowed/required to route this SNC.</dir>
   *
   * SNCType_T <b>sncType</b>:
   * <dir>The NMS must specify the sncType as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</dir>
   *
   * transmissionParameters::LayerRate_T <b>layerRate</b>:
   * <dir>Identifies the layer at which the SNC is to be made.</dir>
   *
   * CrossConnectList_T <b>ccInclusions</b>:
   * <dir>Specifies a list of cross-connects that must be used by the SNC.
   * The list must be empty if no cross-connect constraints are required.  If the EMS
   * cannot fully satisfy the constraints, then the request will be rejected.</dir>
   *
   * ResourceList_T <b>neTpInclusions</b>
   * <dir>Specifies a list of MEs, TLs, PTPs, and/or CTPs that must be used by 
   * the SNC. The list must be empty if no ME/PTP/CTP constraints are required.  
   * If the EMScannot fully satisfy the constraints, then the request will be rejected.</dir>
   *
   * boolean <b>fullRoute</b>
   * <dir>Specifies if the ccInclusions and neTpInclusions constraints describe
   * the full route of the SNC (as opposed to only a partial constraint).
   * When no inclusions constraints are specified, false must be used.</dir>
   *
   * ResourceList_T <b>neTpSncExclusions</b>
   * <dir>Specifies a list of MEs, TLs, PTPs, CTPs, and/or SNCs to be excluded.
   * The SNC to be created must not use any of the NEs, TLs, PTPs, and CTPs 
   * specified, nor any resource used by the SNCs specified.
   * Specifying both inclusion and exclusion constraints is not supported,
   * therefore this list must be empty if ccInclusions or neTpInclusions is non empty.
   * </dir>
   *
   * NamingAttributesList_T <b>aEnd</b>:
   * <dir>The NMS must specify the aEnd as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * Is also used to indicate the Source TP when adding a leg to an existing
   * broadcast system.</dir>
   *
   * NamingAttributesList_T <b>zEnd</b>:
   * <dir>The NMS must specify the zEnd as specified in
   * <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.
   * Is also used to indicate the Sink TP when adding a leg to an existing
   * broadcast system.
   * If the NMS supplies an invalid 
   * combination of TPs in aEnd and zEnd, then the EMS will throw an 
   * INVALID_INPUT exception.
   * Aend and Zend TPs have to be on the same subnetwork.</dir>
   *
   * globaldefs::NVSList_T <b>additionalCreationInfo</b>:
   * <dir>Some additional creation information may be specified by the NMS.
   * For example, for a system which cannot use the routing constraints 
   * for a BLSR case it may supply the pairs:
   * <ul><li>"BLSRDirection" taking values "EAST", "WEST" and "NA"</li>
   * <li>"Timeslot" taking values "1".."nnnnn".</li></ul>
   * This could also be used to carry the "PotentialFutureSetupIndicator" of the aEnd
   * in the case where it has an impact on the creation of the SNC.
   * The list may be empty.</dir>
   * <br>
   **/  
   struct SNCCreateData_T
   {
    string userLabel;
    boolean forceUniqueness;
    string owner;
    globaldefs::ConnectionDirection_T direction;
    StaticProtectionLevel_T staticProtectionLevel;
    ProtectionEffort_T protectionEffort;
    Reroute_T rerouteAllowed;
    NetworkRouted_T networkRouted;
    SNCType_T sncType;
    transmissionParameters::LayerRate_T layerRate;
    CrossConnectList_T ccInclusions;
    ResourceList_T neTpInclusions;
    boolean fullRoute;
    ResourceList_T neTpSncExclusions;
    globaldefs::NamingAttributesList_T aEnd;
    globaldefs::NamingAttributesList_T zEnd;
    globaldefs::NVSList_T additionalCreationInfo;
   };


  /**
   * <p>In order to allow the NMS to deal with a large number of objects,
   * iterators are used.</p>
   * <p>See <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   **/

  interface SNCIterator_I 
    {
        boolean  next_n(in unsigned long               how_many,
                        out SubnetworkConnectionList_T sncList)
          raises (globaldefs::ProcessingFailureException);

        unsigned long getLength()
          raises (globaldefs::ProcessingFailureException);

        void destroy()
          raises (globaldefs::ProcessingFailureException);
    };
  // End of Iterator interface
}; 
#endif