// NOTICE: SEMI makes no warranties or representations as to the suitability of
// the standards set forth herein for any particular application. The
// determination of the suitability of the standard is solely the responsibility
// of the user. Users are cautioned to refer to manufacturer's instructions,
// product labels, product data sheets, and other relevant literature,
// respecting any materials or equipment mentioned herein. These standards
// are subject to change without notice.
//
// By publication of this standard, Semiconductor Equipment and Materials
// International (SEMI) takes no position respecting the validity of any patent
// rights or copyrights asserted in connection with any items mentioned in this
// standard. Users of this standard are expressly advised that determination of
// any such patent rights or copyrights, and the risk of infringement of such
// rights are entirely their own responsibility.

// This proto file will define representations of objects in SEMI E132 in the Protocol Buffer 3 language

syntax = "proto3";

package semi;

// Import statements allow Protocol Buffer messages defined in this .proto file to use
// Protocol Buffer messages defined in other .proto files
// Import statements need to match the filenames of the corresponding .proto files to import for
// this .proto file to compile properly.
//
// This .proto file can import .proto files corresponding to newer revisions of SEMI Standards
// used by this SEMI Standard as long as they are compatible (e.g. the SEMI standard revision corresponding
// to the .proto file to import is the latest revision referenced by the SEMI standard corresponding to this
// .proto file.
// * This allows referenced SEMI Standards to be updated without having to constantly update the import statements
//   used by this .proto file.
// * For example, implementers can update the import statement referencing the .proto file corresponding to a newer
//   revision of SEMI E179.
// * If a specific revision of the referenced SEMI Standard is required, this .proto file will be explicitly updated to
//   import the corresponding .proto file of the referenced SEMI standard as part of updates to this .proto file.

import "semi_e179-1224.proto";

import "google/protobuf/descriptor.proto";

// ***************************************************************
// Version information
// ***************************************************************

// Protobuf3 doesn't support the concept of constants
// We want a way for the implementor to get the .proto file version
// if they want to log or check this information.
// We workaround the issue by exposing a file attribute with the version information
// Information corresponding to the associated SEMI Standard as a custom file option on the .proto file.
//
// Note - the proto_buf_file_version will uniquely identify the .proto file version.
// * For the .proto file associated with the official standard, the proto_buf_file_version will
//   be the SEMI Standard version (including the publication date in MMYY format)
//   For example,
//     proto_buf_file_version="E134.2-MMYY" will indicate this .proto file is for
//     an official SEMI Version (SEMI E134.2-MMYY)
// * If the .proto file is for an interim release (for example as part of a ballot),
//   suffix information along the lines of "-Ballot<nnnn>-<Date>" can be added.
//   For example,
//     proto_buf_file_version="E134.2-Ballot1234-20180522" will indicate this .proto file is an interim version for
//     SEMI E134.2-XXXX Ballot 1234 and was released on May 22, 2018
//
// Note - semi_standard_information Field is defined once in the SEMI E179 .proto file

option (semi_standard_information) =
{
  semi_standard : "SEMI E132.2",
  proto_buf_file_version : "SEMIE132-02-1224"
};

// INTERNAL - For reference only
// INTERNAL - E132.2 schema file (E132-1-V0310-Schema.xsd) defined XML Namespaces as:
// INTERNAL - <xsd:schema xmlns="urn:semi-org:xsd.E132-1.V0310.auth"
// INTERNAL - xmlns:auth="urn:semi-org:xsd.E132-1.V1107.auth"
// INTERNAL - xmlns:ccs="urn:semi-org:xsd.E138.V0709.ccs"
// INTERNAL - xmlns:xms="urn:semi-org:xsd.E128.V0706.xms"
// INTERNAL - xmlns:xsd="http://www.w3.org/2001/XMLSchema"
// INTERNAL - xmlns:ns1="urn:semi-org:xsd.E138.V0709.ccs"

// ***************************************************************
// Enumerated Type Definitions
// ***************************************************************

// Best Practice is to specify Unknown element as index 0 for future proofing
// Enum elements need to be unique across the namespace, so make sure Unknown element name
// is meaningful to the enum.

// Defines notification message destinations
enum NotificationDestination
{
  NOTIFICATION_DESTINATION_UNSPECIFIED = 0;   // Value when unspecified enum value is received - per Protocol Buffers best practice
  CLIENT_ONLY = 1;                            // Only to the Client.
  CONSUMER_ONLY = 2;                          // Only to the Consumer.
  BOTH = 3;                                   // Both the Client and Consumer.
  NONE = 4;                                   // Equipment Server does not any send notification messages for this session.

  reserved 5 to 999;                          // Reserved for future use
}

// Defines operational message destinations
enum OperationalDestination
{
  OPERATIONAL_DESTINATION_UNSPECIFIED = 0;    // Value when unspecified enum value is received - per Protocol Buffers best practice
  CLIENT = 1;                                 // To the Client.
  CONSUMER = 2;                               // To the Consumer.
  NO_OPERATIONAL_DESTINATION = 3;             // Equipment Server does not any send operational messages for this session.
                                              // Maps to the SEMI E132 OperationalDestination.None value
                                              // INTERNAL - Cannot use None as the enumerated value field name as it not unique.

  reserved 4 to 999;                          // Reserved for future use
}

// ***************************************************************
// Message Definitions
// ***************************************************************

// INTERNAL - EndPointType is an abstract class.  No need to define a message type for it
// INTERNAL - Parent objects will reference the derived types directly
// INTERNAL - <xsd:complexType name="EndPointType">
// INTERNAL -         <xsd:sequence/>
// INTERNAL - </xsd:complexType>

// Specifies a network connection point
// This is different than a URL, which also includes the webservice information
message PortConfigurationType
{
  string target_address = 1;        // Target Address of the network connection point
  uint32 port_number = 2;           // Port to connect to
  bool use_secure_connection = 3;   // Indicates if this should be a secure connection
}

// INTERNAL - Endpoint configuration for communication protocols based on HTTP
// The HTTP Endpoint can be either a URL, or a connection point
// For endpoints using gRPC/Protocol Buffers, ConnectionPort should be specified
// Url should be used with Freeze 2 interfaces (using HTTP1.1 with SOAP/XML)
message HttpEndPointType    // INTERNAL - <xsd:complexType name="HTTPEndPointType" final="#all">
{
  oneof endpoint
  {
    string url = 1;         // INTERNAL - <xsd:element name="URL" type="xsd:anyURI" nillable="false"/>
    PortConfigurationType connection_port = 2;
  }
}

// INTERNAL - No need to define a message type for EndPointSelectorType since there is no need to
// INTERNAL - support a choice of endpoints.
// INTERNAL - <xsd:complexType name="EndPointSelectorType" final="#all">
// INTERNAL -         <xsd:choice>
// INTERNAL -                 <xsd:element name="HTTPEndPoint" type="HTTPEndPointType" nillable="false"/>
// INTERNAL -         </xsd:choice>
// INTERNAL - </xsd:complexType> abc

message ActiveSessionType   // INTERNAL - <xsd:complexType name="ActiveSessionType" final="#all">
{
  string session_id = 1;    // INTERNAL - <xsd:element ref="xms:SessionId"/>
  string client_id = 2;     // INTERNAL - <xsd:element name="ClientID" type="xsd:string" nillable="false"/>
  OperationalDestination operational_recipient = 3;
  // INTERNAL - use oneof so that it is clear and easy to detect if no endpoint information
  // INTERNAL - is specified (for example, creating session for the Security Admin Agent only -
  // INTERNAL - no operational messages sent for the session)
  oneof endpoint
  {
    HttpEndPointType session_end_point = 4;   // INTERNAL - Reference HttpEndPointType directly
                                              // INTERNAL - <xsd:element name="SessionEndPoint" type="EndPointSelectorType" nillable="false"/>
  }
}

message PrincipalType   // INTERNAL - <xsd:complexType name="PrincipalType" final="#all">
{
  string principal_id = 1;    // INTERNAL - Human Readable name that originally came from SubjectType
                              // INTERNAL -         <xsd:complexContent>
                              // INTERNAL -                 <xsd:extension base="SubjectType"/>
  bytes salt = 2;             // INTERNAL - salt value for the principal
  bytes password_hash = 3;    // INTERNAL - hashed password for the principal
}

message RoleType    // INTERNAL - <xsd:complexType name="RoleType" final="#all">
{
  string role_id = 1;   // INTERNAL - Human Readable name that originally came from SubjectType
                        // INTERNAL -         <xsd:complexContent>
                        // INTERNAL -                 <xsd:extension base="SubjectType"/>
}

// INTERNAL - Do not need SubjectType as that information was put directly into the parent messages
// INTERNAL - <xsd:complexType name="SubjectType">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element name="ID" type="xsd:string" nillable="false"/>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

message RoleAssignmentType    // INTERNAL - <xsd:complexType name="RoleAssignmentType" final="#all">
{
  PrincipalType principal = 1;    // INTERNAL - <xsd:element name="Principal" type="PrincipalType" nillable="false"/>
  RoleType role = 2;              // INTERNAL - <xsd:element name="Role" type="RoleType" nillable="false"/>
}

// INTERNAL - Don't need this class - define PrivilegeId in parent message directly
// INTERNAL - <xsd:complexType name="PrivilegeType" final="#all">
// INTERNAL - <xsd:sequence>
// INTERNAL -         <xsd:element name="PrivilegeId" type="xsd:string" nillable="false"/>
// INTERNAL - </xsd:sequence>
// INTERNAL - </xsd:complexType>

message SubjectSelectorType   // INTERNAL - <xsd:complexType name="SubjectSelectorType" final="#all">
{
  oneof acl_entry_type              // INTERNAL - <xsd:element name="Subject" type="SubjectSelectorType" nillable="false"/>
  {
    PrincipalType principal = 1;    // INTERNAL -<xsd:element name="Principal" type="PrincipalType" nillable="false"/>
    RoleType role = 2;              // INTERNAL - <xsd:element name="Role" type="RoleType" nillable="false"/>
  }

}

message PrivilegeAssignmentType   // INTERNAL - <xsd:complexType name="PrivilegeAssignmentType" final="#all">
{
  SubjectSelectorType subject = 1;    // INTERNAL - <xsd:element name="Subject" type="SubjectSelectorType" nillable="false"/>
  repeated string privileges = 2;     // Privilege is the PrivilegeId        // INTERNAL - <xsd:element name="Privilege" type="PrivilegeType" nillable="false" maxOccurs="unbounded"/>
}

message ACLEntrySelectorType    // INTERNAL - <xsd:complexType name="ACLEntrySelectorType">
{
  oneof assignment
  {
    PrivilegeAssignmentType privilege_assignment = 1;   // INTERNAL - <xsd:element name="PrivilegeAssignment" type="PrivilegeAssignmentType" nillable="false"/>
    RoleAssignmentType role_assignment = 2;             // INTERNAL - <xsd:element name="RoleAssignment" type="RoleAssignmentType" nillable="false"/>
  }
}

// INTERNAL - No need for dedicated ACLEntryType message - bundled into parent messages
// INTERNAL - <xsd:complexType name="ACLEntryType">
// INTERNAL -         <xsd:sequence/>
// INTERNAL - </xsd:complexType>

message UnauthorizedOperationType   // INTERNAL - <xsd:complexType name="UnauthorizedOperationType" final="#all">
{
  string description = 1;                     // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="false"/>
  repeated string required_privileges = 2;    // RequiredPrivilege is the PrivilegeId  // INTERNAL - <xsd:element name="RequiredPrivilege" type="PrivilegeType" nillable="false" maxOccurs="unbounded"/>
}

message UnrecognizedPrivilegeType   // INTERNAL - <xsd:complexType name="UnrecognizedPrivilegeType" final="#all">
{
  string description = 1;                         // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="false"/>
  repeated string unrecognized_privileges = 2;    // UnrecognizedPrivilege is the PrivilegeId     // INTERNAL - <xsd:element name="UnrecognizedPrivilege" type="PrivilegeType" nillable="false" maxOccurs="unbounded"/>
}

// Get information about the Equipment Server
// This operation does not require SessionID metadata
message GetEquipmentInformationRequestType
{
  string equipment_id = 1;    // Identifies the Equipment Server
  string client_id = 2;       // Identifies the Client
}

message GetEquipmentInformationResponseType
{
  bytes salt = 1;               // Salt value to use with hashing functions
  bytes challenge_token = 2;    // Challenge token for EstablishSession authentication

  oneof error_information
  {
    ErrorType error = 3;        // Use this for regular errors that use ErrorType content
                                // for example Equipment Server not ready
  }
}

// Request changing ACL password
message ChangeACLPasswordRequestType
{
  string client_id = 1;           // Identifies the Client
  bytes salt = 2;                 // Salt value to use with hashing functions
  bytes acl_password_hash = 3;    // New hashed ACL password for the ACLEntry specified by the clientId parameter.  Value cannot be null.
}

message ChangeACLPasswordResponseType
{
  oneof error_information
  {
    ErrorType error = 1;          // Use this for regular errors that use ErrorType content
                                  // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 2;       // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// Check if the Equipment Server is alive
message IsEquipmentServerAliveRequestType
{
}

message IsEquipmentServerAliveResponseType
{
  string equipment_id = 1;    // Identifies the Equipment Server
  oneof error_information
  {
    ErrorType error = 2;      // Use this for regular errors that use ErrorType content
                              // for example UnrecognizedSession
  }
}

message EstablishSessionRequestType   // INTERNAL - <xsd:complexType name="EstablishSessionRequestType" final="#all">
{
  string equipment_id = 1;                                // Identifies the Equipment
  string client_id = 2;                                   // Identifies the Client
  bytes challenge_password_hash = 3;                      // Hashed value used for authentication
  OperationalDestination operational_recipient = 4;       // Specifies who receives the operational messages for this session
  NotificationDestination notification_recipients = 5;    // Specifies who receives notification messages for this session
  // INTERNAL - use oneof so that it is clear and easy to detect if no endpoint information is specified
  // INTERNAL - (for example, creating session for the Security Admin Agent only -
  // INTERNAL - no operational messages sent for the session))
  oneof endpoint
  {
    HttpEndPointType http_end_point = 6;                  // INTERNAL - Reference HttpEndPointType directly
                                                          // INTERNAL - <xsd:element name="EndPoint" type="EndPointSelectorType" nillable="false"/>
  }
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="EstablishSessionErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message EstablishSessionResponseType    // INTERNAL - <xsd:complexType name="EstablishSessionResponseType" final="#all">
{
  string session_id = 1;    // Generated SessionID   // INTERNAL - <xsd:element ref="xms:SessionId"/>
  oneof error_information   // INTERNAL - There are additional errors defined in E132 not included in E132.1
                            // INTERNAL - <xsd:element name="Error" type="EstablishSessionErrorType" nillable="false"/>
  {
    ErrorType error = 2;    // Use this for regular errors that use ErrorType content
                            // for example MaxSessionLimitExceeded, SystemShuttingDown, InvalidEndpoint
                            // InvalidNotificationRecipients, SpecifiedACLAlreadyHasActiveSession
  }
}

// INTERNAL - The method EnhancedEstablishSession was removed with Ballot 6337 - Line Item #3
// INTERNAL - and updated in SEMI E132-0419.
// INTERNAL - It does not need to be supported in the .proto file
// INTERNAL -
// INTERNAL - <xsd:complexType name="EnhancedEstablishSessionRequestType" final="#all">
// INTERNAL -   <xsd:sequence>
// INTERNAL -      <xsd:element name="Capabilities" type="CapabilityType" nillable="false"/>
// INTERNAL -      <xsd:element name="EndPoint" type="EndPointSelectorType" nillable="false"/>
// INTERNAL -   </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Ballot 6337 - LI #3 only removed EnhancedEstablishSession.  It didn't eliminate RequestRejectedReason.
// INTERNAL - This will be removed in an upcoming ballot E132 SEMI Ballot.
// INTERNAL - It does not need to be supported in the .proto file
// INTERNAL -
// INTERNAL - <xsd:complexType name="RejectType" final="#all">
// INTERNAL - <xsd:sequence maxOccurs="unbounded">
// INTERNAL -         <xsd:element name="Capability" type="xsd:string" nillable="false"/>
// INTERNAL -         <xsd:element name="RejectReason" type="xsd:string" nillable="false"/>
// INTERNAL - </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="RequestRejectErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="RequestRejectError" type="RejectType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - The method EnhancedEstablishSession was removed with Ballot 6337 - Line Item #3
// INTERNAL - and updated in SEMI E132-0419.
// INTERNAL - It does not need to be supported in the .proto file
// INTERNAL -
// INTERNAL - <xsd:complexType name="EnhancedEstablishSessionResponseType" final="#all">
// INTERNAL -   <xsd:sequence>
// INTERNAL -         <xsd:choice>
// INTERNAL -                 <xsd:element ref="xms:SessionId"/>
// INTERNAL -                 <xsd:element name="Error" type="RequestRejectErrorType" nillable="false"/>
// INTERNAL -         </xsd:choice>
// INTERNAL -   </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message CloseSessionRequestType     // INTERNAL - <xsd:complexType name="CloseSessionRequestType" final="#all">
{
  string session_id_to_close = 1;   // SessionId to close           // INTERNAL - <xsd:element ref="xms:SessionId"/>
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="CloseSessionErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message CloseSessionResponseType    // INTERNAL - <xsd:complexType name="CloseSessionResponseType" final="#all">
{
  oneof error_information           // INTERNAL - There are additional errors defined in E132 not included in E132.1
                                    // INTERNAL - <xsd:element name="Error" type="CloseSessionErrorType" nillable="false" minOccurs="0"/>
  {
    ErrorType error = 1;            // Use this for regular errors that use ErrorType content
                                    // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 2;       // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// Note - cannot change the endpoint to a null value.
// Note - If a session changes so there is no Consumer associated with the session anymore
// close the session. (Cannot change the endpoint to a null value).
message InitiateChangeSessionEndpointRequestType
{
  HttpEndPointType end_point = 1;   // New endpoint information     // INTERNAL - Reference HttpEndPointType directly
}

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message InitiateChangeSessionEndpointResponseType
{
  oneof error_information           // INTERNAL - There are additional errors defined in E132 not included in E132.1
  {
    ErrorType error = 2;            // Use this for regular errors that use ErrorType content
                                    // for example InvalidEndpoint, UnrecognizedSession, SystemShuttingDown
    UnauthorizedOperationType unauthorized_operation_error = 3;
  }
}

message SessionClosedNotificationType // INTERNAL - <xsd:complexType name="SessionClosedNotificationType" final="#all">
{
  // Session that was closed
  string session_id_hash = 1;   // Since this message is part of the SEMI E132 SessionClient interface, ID values are hashed
                                // ID is SessionId
}

message AclPasswordChangedNotificationType
{
  // Session whose clientId's ACL password changed
  string session_id_hash = 1;   // Since this message is part of the SEMI E132 SessionClient interface, ID values are hashed
                                // ID is SessionId
}

// SessionPing can be sent by Equipment Server
// The message could be sent in a request stream or a response stream
// so the message name doesn't include Request or Response keyword to avoid confusion
// For example, the SessionPingQueryType message can be sent in a Request Stream
// INTERNAL - Currently no fields are required in this message.
// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message SessionPingQueryType    // INTERNAL - <xsd:complexType name="SessionPingRequestType" final="#all">
{
}

// SessionPing can be sent by Equipment Server
// The message could be sent in a request stream or a response stream
// so the message name doesn't include Request or Response keyword to avoid confusion
// The SessionID is sent as part of the gRPC metadata
// If the SessionID is unrecognized, the streaming gRPC method should fail
// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata

message SessionPingAnswerType   // INTERNAL - <xsd:complexType name="SessionPingResponseType" final="#all">
{
  // If the Query was sent by the Equipment Server, this value will be the ClientId
  // The gRPC connection this message will be sent on is not secure, so the
  // ID should be hashed (and IdHash field should be populated)
  oneof reported_id
  {
    string id = 1;          // ID value in plain-text
                            // INTERNAL - <xsd:element name="ID" type="xsd:string" nillable="false"/>
    string id_hash = 2;     // ID value hashed
  }

  oneof error_information   // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                            // INTERNAL - <xsd:element ref="ccs:Error"/>
  {
    ErrorType error = 3;    // Use this for regular errors that use ErrorType content
                            // For example, NotReady
  }
}

message SessionEstablishedNotificationType
{
  bool from_frozen = 1;     // Indicates if the session was restored from FROZEN state
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message SessionFrozenNotificationType   // INTERNAL - <xsd:complexType name="SessionFrozenNotificationType" final="#all">
{
}

// Notification that the request to change the session endpoint with an InitiateChangeSessionEndpoint() operation is complete.
message InitiateChangeSessionEndpointCompleteNotificationType
{
  HttpEndPointType new_end_point = 1;   // New endpoint where session data was requested to be sent to
                                        // INTERNAL - Reference HttpEndPointType directly

  oneof error_information               // INTERNAL -Use same Error structure as other response messages
  {
    ErrorType error = 2;                // Use this for regular errors that use ErrorType content
                                        // for example Could not change the session endpoint
  }
}

message SessionEndpointChangedNotificationType
{
  HttpEndPointType new_end_point = 1;         // New endpoint where operational messages are being sent
                                              // INTERNAL - Reference HttpEndPointType directly

  HttpEndPointType previous_end_point = 2;    // Previous endpoint where operational messages were sent
                                              // INTERNAL - Reference HttpEndPointType directly
}

message DefinedPrivilegeType    // INTERNAL - <xsd:complexType name="DefinedPrivilegeType" final="#all">
{
  string privilege_id = 1;      // INTERNAL - <xsd:element name="PrivilegeID" type="xsd:string" nillable="false"/>
  string description = 2;       // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="false"/>
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message GetDefinedPrivilegesRequestType   // INTERNAL - <xsd:complexType name="GetDefinedPrivilegesRequestType" final="#all">
{
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="GetDefinedPrivilegesErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message GetDefinedPrivilegesResponseType    // INTERNAL - <xsd:complexType name="GetDefinedPrivilegesResponseType" final="#all">
{
  repeated DefinedPrivilegeType privileges = 1;   // INTERNAL - <xsd:element name="Privilege" type="DefinedPrivilegeType" nillable="false" maxOccurs="unbounded"/>

  oneof error_information                         // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                                                  // INTERNAL - <xsd:element name="Error" type="GetDefinedPrivilegesErrorType" nillable="false"/>
  {
    ErrorType error = 2;                          // Use this for regular errors that use ErrorType content
                                                  // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 3;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message GetACLRequestType   // INTERNAL - <xsd:complexType name="GetACLRequestType" final="#all">
{
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="GetACLErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages

message GetACLResponseType    // INTERNAL - <xsd:complexType name="GetACLResponseType" final="#all">

{
  repeated ACLEntrySelectorType acl_entries = 1;    // INTERNAL - Renamed to ACLEntry for readability and consistency
                                                    // INTERNAL - <xsd:element name="ACL" type="ACLEntrySelectorType" nillable="false" maxOccurs="unbounded"/>

  oneof error_information                           // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                                                    // INTERNAL - <xsd:element name="Error" type="GetACLErrorType" nillable="false"/>
  {
    ErrorType error = 2;                            // Use this for regular errors that use ErrorType content
                                                    // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 3;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message AddACLEntryRequestType    // INTERNAL - <xsd:complexType name="AddACLEntryRequestType" final="#all">
{
  ACLEntrySelectorType acl_entry = 1;   // INTERNAL - <xsd:element name="ACLEntry" type="ACLEntrySelectorType" nillable="false"/>
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="AddACLEntryErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -        <xsd:element name="UnrecognizedPrivilegeError" type="UnrecognizedPrivilegeType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message AddACLEntryResponseType   // INTERNAL - <xsd:complexType name="AddACLEntryResponseType" final="#all">
{
  oneof error_information   // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                            // INTERNAL - <xsd:element name="Error" type="GetACLErrorType" nillable="false"/>
   {
    ErrorType error = 2;    // Use this for regular errors that use ErrorType content
                            // for example DuplicateEntryFound, UnrecognizedRole, UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 3;       // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
    UnrecognizedPrivilegeType unrecognized_privilege_error = 4;       // INTERNAL - <xsd:element name="UnrecognizedPrivilegeError" type="UnrecognizedPrivilegeType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message DeleteACLEntryRequestType   // INTERNAL - <xsd:complexType name="DeleteACLEntryRequestType" final="#all">
{
  string subject_id = 1;    // INTERNAL - <xsd:element name="SubjectID" type="xsd:string" nillable="false"/>
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="DeleteACLEntryErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message DeleteACLEntryResponseType    // INTERNAL - <xsd:complexType name="DeleteACLEntryResponseType" final="#all">
{
  oneof error_information   // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                            // INTERNAL - <xsd:element name="Error" type="DeleteACLEntryErrorType" nillable="false" minOccurs="0"/>
  {
    ErrorType error = 2;    // Use this for regular errors that use ErrorType content
                            // for example EntryNotFound,UnrecognizedSession, DeletingRoleWithPrincipalsAssigned
    UnauthorizedOperationType unauthorized_operation_error = 3;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message GetActiveSessionsRequestType    // INTERNAL - <xsd:complexType name="GetActiveSessionsRequestType" final="#all">
{
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="GetActiveSessionsErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message GetActiveSessionsResponseType   // INTERNAL - <xsd:complexType name="GetActiveSessionsResponseType" final="#all">
{
  repeated ActiveSessionType active_sessions = 1;   // INTERNAL - <xsd:element name="ActiveSession" type="ActiveSessionType" nillable="false" maxOccurs="unbounded"/>

  oneof error_information                           // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                                                    // INTERNAL - <xsd:element name="Error" type="GetActiveSessionsErrorType" nillable="false"/>
  {
    ErrorType error = 2;                            // Use this for regular errors that use ErrorType content
                                                    // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 3;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message SetMaxSessionsRequestType   // INTERNAL - <xsd:complexType name="SetMaxSessionsRequestType" final="#all">
{
  uint32 max_sessions = 1;    // INTERNAL - <xsd:element name="MaxSessions" type="xsd:int" nillable="false"/>
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="SetMaxSessionsErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message SetMaxSessionsResponseType    // INTERNAL - <xsd:complexType name="SetMaxSessionsResponseType" final="#all">
{
  uint32 session_count = 1;   // INTERNAL - <xsd:element name="SessionCount" type="xsd:int" nillable="false"/>

  oneof error_information     // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                              // INTERNAL - <xsd:element name="Error" type="SetMaxSessionsErrorType" nillable="false"/>
  {
    ErrorType error = 2;      // Use this for regular errors that use ErrorType content
                              // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 3;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message GetMaxSessionsRequestType   // INTERNAL - <xsd:complexType name="GetMaxSessionsRequestType" final="#all">
{
}

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="GetMaxSessionsErrorType" final="#all">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element ref="ccs:Error"/>
// INTERNAL -                 <xsd:choice minOccurs="0">
// INTERNAL -        <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
// INTERNAL -                 </xsd:choice>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Do not need a message for this type since it will be encoded in the response message
// INTERNAL - <xsd:complexType name="GetMaxSessionsResponseBodyType">
// INTERNAL -         <xsd:sequence>
// INTERNAL -                 <xsd:element name="MaxSessions" type="xsd:int" nillable="false"/>
// INTERNAL -                 <xsd:element name="SessionCount" type="xsd:int" nillable="false"/>
// INTERNAL -         </xsd:sequence>
// INTERNAL - </xsd:complexType>

// INTERNAL - Changed the message organization to be consistent in Error structure as other response type messages
message GetMaxSessionsResponseType    // INTERNAL - <xsd:complexType name="GetMaxSessionsResponseType" final="#all">
{
  // INTERNAL - include content of GetMaxSessionsResponseBodyType always
  // INTERNAL - <xsd:element name="GetMaxSessionsResponseBody" type="GetMaxSessionsResponseBodyType" nillable="false"/>
  uint32 max_session = 1;     // INTERNAL - Use single form in member name
                              // INTERNAL - <xsd:element name="MaxSessions" type="xsd:int" nillable="false"/>
  uint32 session_count = 2;   // INTERNAL - <xsd:element name="SessionCount" type="xsd:int" nillable="false"/>

  oneof error_information     // INTERNAL - Even though there is currently only one error, use same Error structure as other response messages
                              // INTERNAL - <xsd:element name="Error" type="GetMaxSessionsErrorType" nillable="false"/>
  {
    ErrorType error = 3;      // Use this for regular errors that use ErrorType content
                              // for example UnrecognizedSession
    UnauthorizedOperationType unauthorized_operation_error = 4;   // INTERNAL - <xsd:element name="UnauthorizedOperationError" type="UnauthorizedOperationType" nillable="false"/>
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
message SetSessionPingSettingsRequestType
{
  uint32 ping_interval = 1;
  uint32 ping_response_timeout = 2;
  uint32 ping_maximum_failures = 3;
  uint32 ping_retry_interval = 4;
}

message SetSessionPingSettingsResponseType
{
  oneof error_information
  {
    ErrorType error = 2;    // Use this for regular errors that use ErrorType content
                            // for example SystemShuttingDown, InvalidNewSessionPingSettings
    UnauthorizedOperationType unauthorized_operation_error = 3;
  }
}

// INTERNAL - With E132.1, the SessionId of the EDA Client was specified in the SOAP Header
// INTERNAL - With gRPC/Protocol Buffers, it will be specified in the gRPC metadata
// INTERNAL - Currently no fields are required in this message
message GetSessionPingSettingsRequestType
{
}

message GetSessionPingSettingsResponseType
{
  uint32 ping_interval = 1;
  uint32 ping_response_timeout = 2;
  uint32 ping_maximum_failures = 3;
  uint32 ping_retry_interval = 4;

  oneof error_information
  {
    ErrorType error = 5;    // Use this for regular errors that use ErrorType content
                            // for example SystemShuttingDown
    UnauthorizedOperationType unauthorized_operation_error = 6;
  }
}

message GetNewSaltRequestType
{
}

message GetNewSaltResponseType
{
  bytes salt = 1;
  oneof error_information
  {
    ErrorType error = 2;    // Use this for regular errors that use ErrorType content
                            // for example SystemShuttingDown
    UnauthorizedOperationType unauthorized_operation_error = 3;
  }
}

// Container message for all the items that could be sent on the stream to the Equipment Server
// related to session usage
message SessionUsageStreamRequest
{
  oneof request
  {
    SessionPingAnswerType session_ping_answer_from_receiver = 1;    // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingAnswerType" final="#all"/>
  }
}

// Container message for all the items that could be sent on the stream from the Equipment Server
// related to session usage
// Note - Since this streaming method can be used by a Client, the SessionPing from the Equipment Server message is included.
message SessionUsageStreamResponse
{
  oneof result
  {
    // INTERNAL – Equipment Server does not respond to a SessionPing from the EDA Client, so no need for SessionPingResponse
    // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingResponseType" final="#all"/>
    SessionEstablishedNotificationType session_established_notification = 1;
    SessionFrozenNotificationType session_frozen_notification = 2;    // INTERNAL - WebService - <xsd:element name="SessionFrozenNotification" type="SessionFrozenNotificationType" final="#all"/>
    SessionClosedNotificationType session_closed_notification = 3;    // INTERNAL - WebService - <xsd:element name="SessionClosedNotification" type="SessionClosedNotificationType" final="#all"/>
    SessionPingQueryType session_ping_query_to_receiver = 4;          // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingQueryType" final="#all"/>
    InitiateChangeSessionEndpointCompleteNotificationType initiate_change_session_endpoint_complete_notification = 5;
    SessionEndpointChangedNotificationType session_endpoint_changed_notification = 6;
    AclPasswordChangedNotificationType acl_password_changed_notification = 7;
  }
}

// Container message for all the items that could be sent on the stream from the Equipment Server
// related to session information
// Note - this interface is for the Equipment Server to push information to the Consumer.
message ConsumerSessionUsageStreamRequest
{
  oneof request
  {
    SessionPingQueryType session_ping_query_to_receiver = 1;          // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingQueryType" final="#all"/>
    SessionEstablishedNotificationType session_established_notification = 2;
    SessionFrozenNotificationType session_frozen_notification = 3;    // INTERNAL - WebService - <xsd:element name="SessionFrozenNotification" type="SessionFrozenNotificationType" final="#all"/>
    SessionClosedNotificationType session_closed_notification = 4;    // INTERNAL - WebService - <xsd:element name="SessionClosedNotification" type="SessionClosedNotificationType" final="#all"/>
    InitiateChangeSessionEndpointCompleteNotificationType initiate_change_session_endpoint_complete_notification = 5;
    SessionEndpointChangedNotificationType session_endpoint_changed_notification = 6;
    AclPasswordChangedNotificationType acl_password_changed_notification = 7;
  }
}

// Container message for all the items that could be sent on the stream to the Equipment Server
// related to session information
// Note - this interface is for the Equipment Server to receive information from the Consumer.
message ConsumerSessionUsageStreamResponse
{
  oneof result
  {
    SessionPingAnswerType session_ping_answer_from_receiver = 1;    // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingAnswerType" final="#all"/>
  }
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
message EquipmentInterfaceDescriptionType   // INTERNAL -   <xsd:complexType name="EquipmentInterfaceDescriptionType">
{
  string name = 1;                                // INTERNAL - <xsd:element name="Name" type="xsd:string" nillable="false" />
  string description = 2;                         // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="true" />
  repeated SessionGroupType session_groups = 3;   // INTERNAL -       <xsd:element name="SessionGroup" type="SessionGroupType" nillable="false" minOccurs="0" maxOccurs="unbounded" />
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
message SessionGroupType    // INTERNAL -   <xsd:complexType name="SessionGroupType">
{
  string name = 1;                                                // INTERNAL - <xsd:element name="Name" type="xsd:string" nillable="false" />
  string description = 2;                                         // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="true" />
  InterfaceDescriptionType session_manager = 3;                   // INTERNAL - <xsd:element name="SessionManager" type="InterfaceDescriptionType" nillable="false" />
  InterfaceDescriptionType security_admin = 4;                    // INTERNAL - <xsd:element name="SecurityAdmin" type="InterfaceDescriptionType" nillable="false" />
  repeated InterfaceDescriptionType interface_descriptions = 5;   // INTERNAL - <xsd:element name="InterfaceDescription" type="InterfaceDescriptionType" nillable="false" minOccurs="0" maxOccurs="unbounded" />
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
message InterfaceDescriptionType  // INTERNAL -   <xsd:complexType name="InterfaceDescriptionType">
{
  string name = 1;                // INTERNAL - <xsd:element name="Name" type="xsd:string" nillable="false" />
  string description = 2;         // INTERNAL - <xsd:element name="Description" type="xsd:string" nillable="true" />

  // Only one of URL or ConnectionPort can be specified, so the oneof structure will be used
  oneof endpoint
  {
    string url = 3;               // INTERNAL - string for anyURI
                                  // INTERNAL - <xsd:element name="URL" type="xsd:anyURI" nillable="false" />
    PortConfigurationType connection_port = 4;
  }

  string standard = 5;            // INTERNAL - <xsd:element name="Standard" type="xsd:string" nillable="true" />
  string standard_name = 6;       // INTERNAL - <xsd:element name="StandardName" type="xsd:string" nillable="true" />
  string standard_version = 7;    // INTERNAL - <xsd:element name="StandardVersion" type="xsd:string" nillable="true" />
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
// Since the GetInterface is available to everyone, SessionId information is not required as a parameter
message GetInterfacesRequestType    // INTERNAL -   <xsd:complexType name="GetInterfacesRequestType" final="#all">
{
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
// Since the GetInterface is available to everyone, SessionId information is not required as a parameter
message GetInterfacesResponseType   // INTERNAL -   <xsd:complexType name="GetInterfacesResponseType">
{
  repeated EquipmentInterfaceDescriptionType equipment_interface_descriptions = 1;   // INTERNAL - <xsd:element name="EquipmentInterfaceDescription" type="EquipmentInterfaceDescriptionType" nillable="false" />
}

// INTERNAL - Currently no fields are required in this message.  Defined as a separate Request message for future proofing.
message ConfirmConnectionRequestType
{
}

// INTERNAL - Currently no fields are required in this message.  Defined as a separate Request message for future proofing.
message ConfirmConnectionResponseType
{
}

// ***************************************************************
// Service Definitions
// ***************************************************************

// This gRPC service looks after security administration functionality defined in SEMI E132.
service E132SecurityAdmin
{
  // *********************************************************************
  // Unary Request/Response methods to manage Security metadata
  // *********************************************************************

  // INTERNAL - WebService - <xsd:element name="GetDefinedPrivilegesRequest" type="GetDefinedPrivilegesRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="GetDefinedPrivilegesResponse" type="GetDefinedPrivilegesResponseType" final="#all"/>
  rpc GetDefinedPrivileges (GetDefinedPrivilegesRequestType) returns (GetDefinedPrivilegesResponseType ) {}

  // INTERNAL - WebService - <xsd:element name="GetACLRequest" type="GetACLRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="GetACLResponse" type="GetACLResponseType" final="#all"/>
  rpc GetACL (GetACLRequestType) returns (GetACLResponseType) {}

  // INTERNAL - WebService - <xsd:element name="AddACLEntryRequest" type="AddACLEntryRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="AddACLEntryResponse" type="AddACLEntryResponseType" final="#all"/>
  rpc AddACLEntry (AddACLEntryRequestType) returns (AddACLEntryResponseType) {}

  // INTERNAL - WebService - <xsd:element name="DeleteACLEntryRequest" type="DeleteACLEntryRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="DeleteACLEntryResponse" type="DeleteACLEntryResponseType" final="#all"/>
  rpc DeleteACLEntry (DeleteACLEntryRequestType) returns (DeleteACLEntryResponseType) {}

  // INTERNAL - WebService - <xsd:element name="GetActiveSessionsRequest" type="GetActiveSessionsRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="GetActiveSessionsResponse" type="GetActiveSessionsResponseType" final="#all"/>
  rpc GetActiveSessions (GetActiveSessionsRequestType) returns (GetActiveSessionsResponseType) {}

  // INTERNAL - WebService - <xsd:element name="SetMaxSessionsRequest" type="SetMaxSessionsRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SetMaxSessionsResponse" type="SetMaxSessionsResponseType" final="#all"/>
  rpc SetMaxSessions (SetMaxSessionsRequestType) returns (SetMaxSessionsResponseType) {}

  // INTERNAL - WebService - <xsd:element name="GetMaxSessionsRequest" type="GetMaxSessionsRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="GetMaxSessionsResponse" type="GetMaxSessionsResponseType" final="#all"/>
  rpc GetMaxSessions (GetMaxSessionsRequestType) returns (GetMaxSessionsResponseType) {}

  rpc SetSessionPingSettings  (SetSessionPingSettingsRequestType) returns (SetSessionPingSettingsResponseType) {}

  rpc GetSessionPingSettings  (GetSessionPingSettingsRequestType) returns (GetSessionPingSettingsResponseType) {}

  rpc GetNewSalt  (GetNewSaltRequestType) returns (GetNewSaltResponseType) {}

  // *********************************************************************
  // Streaming  methods
  // *********************************************************************
  // None

}

// This service looks after Session functionality defined in SEMI E132 that is done by a Client (management and receiving messages)
// It is in a separate service from the Security Administration functionality to support scenarios where implementations have
// this functionality separated.
service E132SessionManagement
{
  // *********************************************************************
  // Unary Request/Response methods to manage Sessions
  // *********************************************************************
  rpc GetEquipmentInformation (GetEquipmentInformationRequestType) returns (GetEquipmentInformationResponseType ) {}

  rpc ChangeACLPassword (ChangeACLPasswordRequestType) returns (ChangeACLPasswordResponseType ) {}

  rpc IsEquipmentServerAlive (IsEquipmentServerAliveRequestType) returns (IsEquipmentServerAliveResponseType ) {}

  // INTERNAL - WebService - <xsd:element name="EstablishSessionRequest" type="EstablishSessionRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="EstablishSessionResponse" type="EstablishSessionResponseType" final="#all"/>
  rpc EstablishSession (EstablishSessionRequestType) returns (EstablishSessionResponseType ) {}

  // INTERNAL - The method EnhancedEstablishSession was removed with Ballot 6337 - Line Item #3
  // INTERNAL - and updated in SEMI E132-0419.  Support for it does not need to be included in the the .proto file.
  // INTERNAL - Client -> Server messages
  // INTERNAL - WebService - <xsd:element name="EnhancedEstablishSessionRequest" type="EnhancedEstablishSessionRequestType" final="#all"/>
  // INTERNAL - Server -> Client messages
  // INTERNAL - WebService - <xsd:element name="EnhancedEstablishSessionResponse" type="EnhancedEstablishSessionResponseType" final="#all"/>

  // INTERNAL - WebService - <xsd:element name="CloseSessionRequest" type="CloseSessionRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="CloseSessionResponse" type="CloseSessionResponseType" final="#all"/>

  rpc CloseSession (CloseSessionRequestType) returns (CloseSessionResponseType ) {}

  rpc InitiateChangeSessionEndpoint (InitiateChangeSessionEndpointRequestType) returns (InitiateChangeSessionEndpointResponseType) {}

  // *********************************************************************
  // Streaming  methods
  // *********************************************************************

  // INTERNAL - Design Decision - Handle SessionPing from Equipment Server to the Client as a stream
  // INTERNAL - because the Client software can do other stuff while waiting for a response.
  // INTERNAL - This means several existing WebService are combined into one gRPC method
  // INTERNAL - Client -> Server messages
  // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingRequestType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingResponseType" final="#all"/>
  // INTERNAL - Server -> Client messages
  // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingResponseType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionClosedNotification" type="SessionClosedNotificationType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionFrozenNotification" type="SessionFrozenNotificationType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingRequestType" final="#all"/>
  // INTERNAL - Note – Client no longer sends SessionPing messages to Equipment Server
  // INTERNAL - No need to support SessionPingRequest messages to the equipment
  // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingRequestType" final="#all"/>

  // Establish stream to and from the Server for messages related to session usage (notification, ping)
  rpc SessionUsageStream (stream SessionUsageStreamRequest) returns (stream SessionUsageStreamResponse) {}
}

// This service looks after Session Ping and notification functionality for the Consumer
// It is in a separate service because the Equipment Server opens the connection to the Consumer.
service E132SessionConsumer
{
  // *********************************************************************
  // Unary Request/Response methods
  // *********************************************************************

  // SEMI E132.2 specific method to confirm the connection to the implementing code is working.
  rpc ConfirmConnection (ConfirmConnectionRequestType) returns (ConfirmConnectionResponseType) {}

  // *********************************************************************
  // Streaming  methods
  // *********************************************************************

  // INTERNAL - Design Decision - put all messages related to Consumer on one method.
  // INTERNAL - This means several existing WebService are combined into one gRPC method
  // INTERNAL - Client -> Server messages
  // INTERNAL - WebService - <xsd:element name="SessionPingResponse" type="SessionPingResponseType" final="#all"/>
  // INTERNAL - Server -> Client messages
  // INTERNAL - WebService - <xsd:element name="SessionClosedNotification" type="SessionClosedNotificationType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionFrozenNotification" type="SessionFrozenNotificationType" final="#all"/>
  // INTERNAL - WebService - <xsd:element name="SessionPingRequest" type="SessionPingRequestType" final="#all"/>

  // Establish stream to and from the Server for messages related to session usage (notification, ping)
  rpc ConsumerSessionUsageStream (stream ConsumerSessionUsageStreamRequest) returns (stream ConsumerSessionUsageStreamResponse) {}
}

// INTERNAL - From E132-InterfaceDiscovery.xsd
// This service looks after Interface Discovery functionality defined by SEMI E132 to query the interfaces supported by the equipment.
service E132InterfaceDiscovery
{

  // *********************************************************************
  // Unary Request/Response methods to query interfaces
  // *********************************************************************

  // INTERNAL - WebService - <xsd:element name="GetInterfacesRequest" type="GetInterfacesRequestType" final="#all" />
  // INTERNAL - WebService - <xsd:element name="GetInterfacesResponse" type="GetInterfacesResponseType" final="#all" />
  rpc GetInterfaces (GetInterfacesRequestType) returns (GetInterfacesResponseType) {}

  // *********************************************************************
  // Streaming  methods
  // *********************************************************************
  // None
}