DefaultServer (Portal for Java 0.9.0 API)

java.lang.Object
- io.github.flowersinthesand.portal.DefaultServer

All Implemented Interfaces:

Server

Direct Known Subclasses:

ClusteredServer
```
public class DefaultServer
extends Object
implements Server
```
Default implementation of Server.
This implementation provides and manages Socket processing HTTP request and WebSocket following the portal protocol.
As options, the following methods can be overridden.
Author:

Donghwan Kim

Constructor Summary

Constructors
Constructor and Description

DefaultServer()

Constructors
Constructor and Description
`DefaultServer()`

Method Summary

Methods
Modifier and Type	Method and Description
`Sentence`	`all()` Returns a sentence that all of the socket in this server or all of the server if it's in a clustered environment have to follow.
`Server`	`all(Action<Socket> action)` Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .
`Sentence`	`byId(String id)` Returns a sentence that the socket of the given id in this server or all of the server if it's in a clustered environment have to follow.
`Server`	`byId(String id, Action<Socket> action)` Executes the given action retrieving the socket of the given id in this server or all of the server if it's in a clustered environment.
`Sentence`	`byTag(String... names)` Returns a sentence that the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment have to follow.
`Server`	`byTag(String[] names, Action<Socket> action)` Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment.
`Server`	`byTag(String name, Action<Socket> action)` Executes the given action retrieving the socket tagged with the given name in this server or all of the server if it's in a clustered environment.
`Action<ServerHttpExchange>`	`httpAction()` ServerHttpExchange action to install in wes
`protected Map<String,Object>`	`parseEvent(String text)` Takes a stringified event and returns an event object.
`protected Map<String,String>`	`parseURI(String uri)` Takes a portal URI and returns a map of parameters.
`Server`	`socketAction(Action<Socket> action)` Registers an action to be called when the socket has been opened in this server regardless of clustering.
`protected String`	`stringifyEvent(Map<String,Object> event)` Takes an event object and returns a stringified event.
`Action<ServerWebSocket>`	`websocketAction()` ServerWebSocket action to install in wes

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultServer
```
public DefaultServer()
```
- Method Detail
  - parseURI
```
protected Map<String,String> parseURI(String uri)
```
    Takes a portal URI and returns a map of parameters.
    This is a counterpart of urlBuilder of client option.
  - parseEvent
```
protected Map<String,Object> parseEvent(String text)
```
    Takes a stringified event and returns an event object.
    A text in argument is generated by outbound of client option and this is akin to inbound of client option.
  - stringifyEvent
```
protected String stringifyEvent(Map<String,Object> event)
```
    Takes an event object and returns a stringified event.
    This is akin to outbound of client option and a returned value will be handled by inbound of client option.
  - all
```
public Sentence all()
```
    Description copied from interface: Server
    
    Returns a sentence that all of the socket in this server or all of the server if it's in a clustered environment have to follow.
    
    Specified by:
    
    all in interface Server
  - all
```
public Server all(Action<Socket> action)
```
    Description copied from interface: Server
    
    Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .
    
    Specified by:
    
    all in interface Server
  - byId
```
public Sentence byId(String id)
```
    Description copied from interface: Server
    
    Returns a sentence that the socket of the given id in this server or all of the server if it's in a clustered environment have to follow.
    
    Specified by:
    
    byId in interface Server
  - byId
```
public Server byId(String id,
          Action<Socket> action)
```
    Description copied from interface: Server
    
    Executes the given action retrieving the socket of the given id in this server or all of the server if it's in a clustered environment. The given action will be executed only once if socket is found and won't be executed if not found.
    
    Specified by:
    
    byId in interface Server
  - byTag
```
public Sentence byTag(String... names)
```
    Description copied from interface: Server
    
    Returns a sentence that the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment have to follow.
    
    Specified by:
    
    byTag in interface Server
  - byTag
```
public Server byTag(String name,
           Action<Socket> action)
```
    Description copied from interface: Server
    
    Executes the given action retrieving the socket tagged with the given name in this server or all of the server if it's in a clustered environment. The given action will be executed multiple times if sockets are found and won't be executed if not found.
    
    Specified by:
    
    byTag in interface Server
  - byTag
```
public Server byTag(String[] names,
           Action<Socket> action)
```
    Description copied from interface: Server
    
    Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment. The given action will be executed multiple times if sockets are found and won't be executed if not found.
    
    Specified by:
    
    byTag in interface Server
  - socketAction
```
public Server socketAction(Action<Socket> action)
```
    Description copied from interface: Server
    
    Registers an action to be called when the socket has been opened in this server regardless of clustering. It's allowed to add several actions before and after installation, so you don't need to centralize all your code to one class.
    
    Specified by:
    
    socketAction in interface Server
  - httpAction
```
public Action<ServerHttpExchange> httpAction()
```
    Description copied from interface: Server
    
    ServerHttpExchange action to install in wes
    
    Specified by:
    
    httpAction in interface Server
  - websocketAction
```
public Action<ServerWebSocket> websocketAction()
```
    Description copied from interface: Server
    
    ServerWebSocket action to install in wes
    
    Specified by:
    
    websocketAction in interface Server

Class DefaultServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultServer

Method Detail

parseURI

parseEvent

stringifyEvent

all

all

byId

byId

byTag

byTag

byTag

socketAction

httpAction

websocketAction