CommunicationProtocol (javadoc 2024.12-174331 API)

All Known Implementing Classes:

PollingProtocol
```
public interface CommunicationProtocol
```
Represents communication protocol between Server and Agent.

Field Summary

Fields
Modifier and Type Field Description

static String UNKNOWN_HOST_ERROR_MSG

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getId()`	Unique identifiers of the protocol.
`AgentRegistrationDetails`	`registerOnServer(AgentDetails agentDetails, BuildAgentImpl buildAgent)`	After this call Server-Agent connection is established (in both directions, i.e server can send messages to agent and vice versa).

- Field Detail
  - UNKNOWN_HOST_ERROR_MSG
```
static final String UNKNOWN_HOST_ERROR_MSG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
@NotNull
String getId()
```
    Unique identifiers of the protocol.
  - registerOnServer
```
@NotNull
AgentRegistrationDetails registerOnServer(AgentDetails agentDetails,
                                          BuildAgentImpl buildAgent)
                                   throws ProtocolDoesNotWorkException
```
    After this call Server-Agent connection is established (in both directions, i.e server can send messages to agent and vice versa).
    
    Throws:
    
    AlreadyExistsException - when agent with such name already exists on server.
    
    InvalidRunningBuildException - when Server doesn't recognize build running on agent.
    
    ProtocolDoesNotWorkException - when this protocol doesn't work for some reason.