1 marek 1.1 // Copyright (c) 2009 DMTF.  All rights reserved.
  2              [Version ( "2.22.0" ), 
  3               UMLPackagePath ( "CIM::Core::Service" ), 
  4               Description ( 
  5                  "ProtocolService represents represents an application layer "
  6                  "service available on a hosting system. Often times, the "
  7                  "service name reflects the employed/supported communication "
  8                  "protocol (e.g. file transfer - FTP), however in some other "
  9                  "cases it does not. (e.g. mail notification service - biff). "
 10                  "Access to the service is modeled with one or more instances of "
 11                  "ProtocolEndpoint. This class represents the availability of "
 12                  "the function on the system. Issuing a stop to this instance is "
 13                  "equivalent to disabling the functionality and making it "
 14                  "unavailable to users. Thus a stop of this service will result "
 15                  "in the removing of all ProtocolEndpoints which are associated "
 16                  "with the instance via ServicAccessBySAP. The functionality can "
 17                  "be made available again by issuing a start to the service. "
 18                  "This class contains service definitions which are currently "
 19                  "needed. Future extensions are expected." )]
 20           class CIM_ProtocolService : CIM_Service {
 21           
 22 marek 1.1       [Description ( 
 23                     "The protocol this service provides. Values defined for "
 24                     "this property are limited to the known use cases where "
 25                     "it is desirable to represent the ability to enable or "
 26                     "disable the functionality on the system." ), 
 27                  ValueMap { "0", "1", "2", "3", "4", "5..32767", "32768..65535" }, 
 28                  Values { "Unknown", "Other", "SSH", "Telnet", "CLP", 
 29                     "DMTF Reserved", "Vendor Reserved" }, 
 30                  ModelCorrespondence { "CIM_ProtocolService.OtherProtocol" }]
 31              uint16 Protocol;
 32           
 33                 [Description ( 
 34                     "If the Protocol property is set to 1 \"Other\" then free "
 35                     "form string providing more information about the "
 36                     "protocol. If not set to 1, this string has no meaning." ), 
 37                  ModelCorrespondence { "CIM_ProtocolService.Protocol" }]
 38              string OtherProtocol;
 39           
 40                 [Write, Description ( 
 41                     "MaxConnections specifies the maximum number of "
 42                     "connections currently allowed by the service. The values "
 43 marek 1.1           "32768..65535 are DMTF Reserved." ), 
 44                  MinValue ( 1 ), 
 45                  MaxValue ( 65535 )]
 46              uint16 MaxConnections = 1;
 47           
 48                 [Description ( 
 49                     "CurrentActiveConnections indicates the number of "
 50                     "sessions currently established with the protocol "
 51                     "service. A value of null for this property shall "
 52                     "indicate the number of active sessions is unknown. A "
 53                     "value of zero shall indicate there are no active "
 54                     "sessions. Any other value shall correspond to the number "
 55                     "of active sessions." ), 
 56                  MinValue ( 0 ), 
 57                  MaxValue ( 65535 )]
 58              uint16 CurrentActiveConnections;
 59           
 60           
 61                 [Description ( 
 62                     "Create a CIM_TCPProtocoEndpoint instance and associate "
 63                     "it with this CIM_ProtocolService instance via an "
 64 marek 1.1           "instance of CIM_ServiceAccessBySAP. The newly created "
 65                     "instance of CIM_TCPProtocolEndpoint will be for the port "
 66                     "specified. When the CIM_IPProtocolEndpoint is not "
 67                     "specified, the method will create an instance of "
 68                     "CIM_HostedAccessPoint which associates the newly created "
 69                     "CIM_TCPProtocolEndpoint instance with the instance of "
 70                     "CIM_ComputerSystem with which this instance is "
 71                     "associated via an instance of CIM_HostedService (the "
 72                     "scoping system) It will also create instances of "
 73                     "CIM_BindsTo which associate the created "
 74                     "CIM_TCPProtocolEndpoint with each instance "
 75                     "CIM_IPProtocolEndpoint which is associated with the "
 76                     "scoping system. When an instance of "
 77                     "CIM_IPProtocolEndpoint is specified, the "
 78                     "CIM_HostedAccessPoint will associate the "
 79                     "CIM_TCPProtocolEndpoint with the same instance which is "
 80                     "associated with the CIM_IPProtocolEndpoint. In addition, "
 81                     "the implementation will create a single instance of "
 82                     "CIM_BindsTo that associates the CIM_TCPProtocolEndpoint "
 83                     "with the specified instance of CIM_IPProtocolEndpoint. "
 84                     "For each instance of CIM_BindsTo created by this method, "
 85 marek 1.1           "the value of the Dependent property will be a reference "
 86                     "to the newly created instance of "
 87                     "CIM_TCPProtocolEndpoint. An extrinsic method is required "
 88                     "in order to provide atomic creation of multiple, related "
 89                     "instances. Prior to creating the instances, the "
 90                     "implementation will verify that a "
 91                     "CIM_TCPProtocolEndpoint instance can be created and "
 92                     "associated with this instance." ), 
 93                  ValueMap { "0", "1", "2", "4", "..", "32768..65535" }, 
 94                  Values { "Completed with No Error", "Not Supported", 
 95                     "Error Occurred", "Invalid Port", "DMTF Reserved", 
 96                     "Vendor Reserved" }]
 97              uint32 ListenOnPort(
 98                    [Required, IN, Description ( 
 99                        "The desired listening port." )]
100                 uint32 PortNumber, 
101                    [IN, Description ( 
102                        "A specific CIM_IPProtocolEndpoint on which the "
103                        "service will listen to the specified port." )]
104                 CIM_IPProtocolEndpoint REF IPEndpoint, 
105                    [IN ( false ), OUT, Description ( 
106 marek 1.1              "The created TCPProtocolEndpoint." )]
107                 CIM_TCPProtocolEndpoint REF TCPEndpoint);
108           
109           };