Protocol Service ABE UML Documentation

Element

Resource Domain::Resource ABE::Logical Resource ABE
Class Protocol

A Protocol is a formal set of rules and conventions that governs how two entities exchange information (usually over one or more types of network media).

This is an abstract base class for representing Protocols that can be managed. This class represents a convenient aggregation point for defining how Protocols are managed and used.

Attributes
«example» Device	_device
ResourceFacingService	_resourceFacingService2
Integer	currentPortNumber	This is a non-negative integer that defines the port number used by this protocol.
Boolean	isEphemeral	This is a Boolean attribute. If its value is TRUE, then this protocol can use ephemeral port numbers. If its value is FALSE, then this protocol will only use well-defined port numbers.
Integer	portRangeEnd	This non-negative integer defines the upper range of allowable port numbers to use.
Integer	portRangeStart	This non-negative integer defines the lower range of allowable port numbers to use.
Integer	protocolDirection	This is an enumerated integer that defines the direction of this protocol. Values are: 0: input 1: output 2: bi-directional

Attributes inherited from SID Models::Resource Domain::Resource ABE::Logical Resource ABE::LogicalResource
lrStatus, serviceState, isOperational, resourceFacingService, logicalResourceRole, physicalResource

Attributes inherited from SID Models::Resource Domain::Resource ABE::Resource
_managementDomain, _businessInteractionItem, _resourceRole, _resourceSpecification, _resourceUsage, usageState, _place, _performance2, _resourceFacingService, _product, _resourceCharacteristicValue, _resourceSecurityEntity, _securityEventCollectionMethod, _serviceAccessPoint, _securityThreatTool, _commonResourceInfo, _partyRole3, _partyRole, resourceCapacity, resourceCapacityDemand, _resourceInvolvementRole, _resourceUser, runningSoftwareStatistics, software, compoundResource, resourceConfiguration, resourceConfigSpec, resourceTest, resourceRelationship, resourceRelationship2, resource, resource22, problem2, problem, _alarm_3, _alarm_2, _alarm_1, resourcePerformance

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::Entity
_entityIdentification, _entityRole, managedEntity, characteristicValue

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::RootEntity
_rootEntityType, _revenueAssuranceParmValue, _characteristicValue, name, description, ID, metric, _monitoredMetricInstancesCriteria, directedEdge, vertex, entityCatalogItem, rootEntityGroupMember, rootEntityGroup, rootEntityRelationship, rootEntityRelationship2, associationRole, entitySpecificationAttachment, interactionUseCase, interactionResult

Properties:

Alias
Classifier Behavior
Is Abstract	true
Is Active	false
Is Leaf	false
Keywords
Name	Protocol
Name Expression
Namespace	Protocol Service ABE
Owned Template Signature
Owner	Protocol Service ABE
Owning Template Parameter
Package	Protocol Service ABE
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

_device

Public «example» Device _device

Constraints:

Properties:

Aggregation	None
Alias
Association	DeviceHostsProtocols
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	_device
Name Expression
Namespace	Protocol
Opposite	_protocol
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::_device
Stereotype
Template Parameter
Type	«example» Device
Upper	1
Upper Value	(1)
Visibility	Public

_resourceFacingService2

Public ResourceFacingService _resourceFacingService2

Constraints:

Properties:

Aggregation	None
Alias
Association	ProtocolServiceDetails
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	_resourceFacingService2
Name Expression
Namespace	Protocol
Opposite	_protocol
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::_resourceFacingService2
Stereotype
Template Parameter
Type	ResourceFacingService
Upper	1
Upper Value	(1)
Visibility	Public

currentPortNumber

Public Integer currentPortNumber

This is a non-negative integer that defines the port number used by this protocol.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	currentPortNumber
Name Expression
Namespace	Protocol
Opposite
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::currentPortNumber
Stereotype	required
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

isEphemeral

Public Boolean isEphemeral

This is a Boolean attribute. If its value is TRUE, then this protocol can use ephemeral port numbers. If its value is FALSE, then this protocol will only use well-defined port numbers.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	isEphemeral
Name Expression
Namespace	Protocol
Opposite
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::isEphemeral
Stereotype	required
Template Parameter
Type	Boolean
Upper	1
Upper Value
Visibility	Public

portRangeEnd

Public Integer portRangeEnd

This non-negative integer defines the upper range of allowable port numbers to use.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	portRangeEnd
Name Expression
Namespace	Protocol
Opposite
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::portRangeEnd
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

portRangeStart

Public Integer portRangeStart

This non-negative integer defines the lower range of allowable port numbers to use.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	portRangeStart
Name Expression
Namespace	Protocol
Opposite
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::portRangeStart
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

protocolDirection

Public Integer protocolDirection

This is an enumerated integer that defines the direction of this protocol. Values are:

0: input
1: output
2: bi-directional

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	Protocol
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	protocolDirection
Name Expression
Namespace	Protocol
Opposite
Owner	Protocol
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Resource Domain::Resource ABE::Logical Resource ABE::Protocol Service ABE::Protocol::protocolDirection
Stereotype	required
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

Overview

Top

Package

Element

Protocol Service ABE UML Documentation

Summary:AttributesProperties

Detail:Attributes