BeowulfJConfig (beowulfj-core 0.0.4 API)

java.lang.Object
- com.beowulfchain.beowulfj.configuration.BeowulfJConfig

```
public class BeowulfJConfig
extends Object
```
This class stores the configuration that is used for the communication to the defined server.
The setters can be used to override the default values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEndpointURI(URI endpointURI)` This method has the same functionality than `setEndpointURI(URI, boolean)`, but this method will enable the SSL verification by default.
`void`	`addEndpointURI(URI endpointURI, boolean sslVerificationDisabled)` Configure the connection to the Beowulf Node by providing the endpoint URI and the SSL verification settings.
`AddressPrefixType`	`getAddressPrefix()` Get the currently configured address prefix.
`char[]`	`getApiPassword()` Get the currently configured password used to login at a Beowulf Node to access protected APIs.
`AccountName`	`getApiUsername()` Get the currently configured account name used to login at a Beowulf Node to access protected APIs.
`static AccountName`	`getBeowulfJAccount()`
`static String`	`getBeowulfJAppName()` Get the application name of BeowulfJ.
`static String`	`getBeowulfJVersion()` Get the version of BeowulfJ that is currently used.
`short`	`getBeowulfJWeight()` Get the currently configured beneficiary weight.
`String`	`getChainId()` Get the currently configured chain id used to sign transactions.
`javax.websocket.ClientEndpointConfig`	`getClientEndpointConfig()` Get the configured ClientEndpointConfig instance.
`String`	`getDateTimePattern()` Get the currently configured date time pattern.
`AccountName`	`getDefaultAccount()` Get the currently configured default account name.
`String`	`getDefaultBeowulfApiUri()` Get current super node
`AssetSymbolType`	`getDollarSymbol()` Get the currently configured `AssetSymbolType` for dollars (e.g.
`Charset`	`getEncodingCharset()` Get the currently configured Charset that will be used to encode Strings.
`List<org.apache.commons.lang3.tuple.Pair<URI,Boolean>>`	`getEndpointURIs()`
`int`	`getIdleTimeout()` Get the configured, maximum time that BeowulfJ will keep an unused connection open.
`static BeowulfJConfig`	`getInstance()` Receive a `BeowulfJConfig` instance.
`long`	`getMaximumExpirationDateOffset()` Get the currently configured maximum offset of the expiration date.
`NetworkProperties`	`getNetwork()`
`static BeowulfJConfig`	`getNewInstance()` Overrides the current `BeowulfJConfig` instance and returns a new one.
`org.apache.commons.lang3.tuple.Pair<URI,Boolean>`	`getNextEndpointURI(int selector)` Get one of the configured endpoint URIs by providing a `selector`.
`PrivateKeyStorage`	`getPrivateKeyStorage()` Get the private key storage to manage the private keys for one or multiple accounts.
`int`	`getResponseTimeout()` Get the configured, maximum time that BeowulfJ will wait for an answer of the endpoint before throwing a `BeowulfTimeoutException` exception.
`SynchronizationType`	`getSynchronizationLevel()` Get the currently configured `synchronizationLevel`.
`String`	`getTimeZoneId()` Get the currently configured time zone id.
`AssetSymbolType`	`getTokenSymbol()` Get the currently configured `AssetSymbolType` for tokens (e.g.
`ValidationType`	`getValidationLevel()` Get the currently configured validation level.
`AssetSymbolType`	`getVestsSymbol()` Get the currently configured `AssetSymbolType` for M.
`void`	`setAddressPrefix(AddressPrefixType addressPrefix)` Set the address prefix.
`void`	`setApiPassword(char[] apiPassword)` Set the password which should be used to login to a node.
`void`	`setApiUsername(AccountName apiUsername)` Set the account name which should be used to login to a node.
`void`	`setBeowulfJWeight(short beowulfJWeight)` Set the currently configured beneficiary weight.
`void`	`setChainId(String chainId)` Set the chain id used to sign transactions.
`void`	`setClientEndpointConfig(javax.websocket.ClientEndpointConfig clientEndpointConfig)` Override the default ClientEndpointConfig instance.
`void`	`setDateTime(String dateTimePattern, String timeZoneId)` Override the default date pattern.
`void`	`setDefaultAccount(AccountName defaultAccount)` Set the default account used for simplified operations.
`void`	`setDefaultBeowulfApiUri(String apiUri)` Override the currently configured `DEFAULT_BEOWULF_API_URI`.
`void`	`setDollarSymbol(AssetSymbolType dollarSymbol)` Override the default `dollarSymbol`.
`void`	`setEncodingCharset(Charset encodingCharset)` Define the Charset that should be used to encode Strings.
`void`	`setEndpointURIs(List<org.apache.commons.lang3.tuple.Pair<URI,Boolean>> endpointURIs)` Override the currently configured `endpointURIs`.
`void`	`setIdleTimeout(int idleTimeout)` Override the default, maximum time that BeowulfJ will keep an unused connection open.A value that is 0 or negative indicates the sessions will never timeout due to inactivity.
`void`	`setMaximumExpirationDateOffset(long maximumExpirationDateOffset)` A Beowulf Node will only accept transactions whose expiration date is not to far in the future.
`void`	`setNetwork(NetworkProperties network)`
`void`	`setResponseTimeout(int responseTimeout)` Override the default, maximum time that BeowulfJ will wait for an answer of the Beowulf Node.
`void`	`setSynchronizationLevel(SynchronizationType synchronizationLevel)` Override the currently configured `synchronizationLevel`.
`void`	`setTokenSymbol(AssetSymbolType tokenSymbol)` Override the default `tokenSymbol`.
`void`	`setValidationLevel(ValidationType validationLevel)` Override the default validation level that BeowulfJ will use to validate if an Object contains valid information before broadcasting it to the Beowulf Node.
`void`	`setVestsSymbol(AssetSymbolType vestsSymbol)` Override the default `vestsSymbol`.

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

- Method Detail
  - getInstance
```
public static BeowulfJConfig getInstance()
```
    Receive a BeowulfJConfig instance.
    
    Returns:
    
    A BeowulfJConfig instance.
  - getNewInstance
```
public static BeowulfJConfig getNewInstance()
```
    Overrides the current BeowulfJConfig instance and returns a new one.
    
    Returns:
    
    A BeowulfJConfig instance.
  - getBeowulfJAccount
```
public static AccountName getBeowulfJAccount()
```
    Returns:
    
    The official BeowulfJ account name.
  - getBeowulfJVersion
```
public static String getBeowulfJVersion()
```
    Get the version of BeowulfJ that is currently used. This parameter is set during the build and can't be changed.
    
    Returns:
    
    The BeowulfJ version that is currently used.
  - getBeowulfJAppName
```
public static String getBeowulfJAppName()
```
    Get the application name of BeowulfJ. This parameter is set during the build and can't be changed.
    
    Returns:
    
    The application name of BeowulfJ.
  - getSynchronizationLevel
```
public SynchronizationType getSynchronizationLevel()
```
    Get the currently configured synchronizationLevel.
    The synchronizationLevel defines which values should be synchronized between this BeowulfJ instance and the connected node. By default, BeowulfJ will synchronize as much as possible.
    
    Returns:
    
    The synchronization level.
  - setSynchronizationLevel
```
public void setSynchronizationLevel(SynchronizationType synchronizationLevel)
```
    Override the currently configured synchronizationLevel.
    The synchronizationLevel defines which values should be synchronized between this BeowulfJ instance and the connected node. By default, BeowulfJ will synchronize as much as possible.
    
    Parameters:
    
    synchronizationLevel - The synchronization level to set.
  - getDefaultBeowulfApiUri
```
public String getDefaultBeowulfApiUri()
```
    Get current super node
    
    Returns:
    
    String
  - setDefaultBeowulfApiUri
```
public void setDefaultBeowulfApiUri(String apiUri)
```
    Override the currently configured DEFAULT_BEOWULF_API_URI.
    The DEFAULT_BEOWULF_API_URI define what super node to interact with
    
    Parameters:
    
    apiUri - The api Uri to set.
  - getApiPassword
```
public char[] getApiPassword()
```
    Get the currently configured password used to login at a Beowulf Node to access protected APIs.
    
    Returns:
    
    The currently configured password for the API access.
  - setApiPassword
```
public void setApiPassword(char[] apiPassword)
```
    Set the password which should be used to login to a node. This is not required if the node is not protected.
    
    Parameters:
    
    apiPassword - The password to use.
  - getApiUsername
```
public AccountName getApiUsername()
```
    Get the currently configured account name used to login at a Beowulf Node to access protected APIs.
    
    Returns:
    
    The currently configured account name for the API access.
  - setApiUsername
```
public void setApiUsername(AccountName apiUsername)
```
    Set the account name which should be used to login to a node. This is not required if the node is not protected.
    
    Parameters:
    
    apiUsername - The account name to use.
  - getDefaultAccount
```
public AccountName getDefaultAccount()
```
    Get the currently configured default account name. The default account name is used for operations, if no other account has been provided.
    
    Returns:
    
    The configured default account.
  - setDefaultAccount
```
public void setDefaultAccount(AccountName defaultAccount)
```
    Set the default account used for simplified operations.
    
    Parameters:
    
    defaultAccount - The account to set.
  - getChainId
```
public String getChainId()
```
    Get the currently configured chain id used to sign transactions. For the production chain the id is a 56bit long 0 sequence which is configured by default.
    
    Returns:
    
    The currently configured Chain ID.
  - setChainId
```
public void setChainId(String chainId)
```
    Set the chain id used to sign transactions. For the production chain the id is a 56bit long 0 sequence which is configured by default.
    
    Parameters:
    
    chainId - The chain id to set.
  - getClientEndpointConfig
```
public javax.websocket.ClientEndpointConfig getClientEndpointConfig()
```
    Get the configured ClientEndpointConfig instance. Please be aware that the clientEndpointConfig is only used for WebSocket endpoints.
    
    Returns:
    
    The configured ClientEndpointConfig instance.
  - setClientEndpointConfig
```
public void setClientEndpointConfig(javax.websocket.ClientEndpointConfig clientEndpointConfig)
```
    Override the default ClientEndpointConfig instance.
    
    Parameters:
    
    clientEndpointConfig - The configuration of the client end point.
  - getDateTimePattern
```
public String getDateTimePattern()
```
    Get the currently configured date time pattern. This date pattern is used to serialize and deserialize JSON/Java objects.
    
    Returns:
    
    The used date time pattern used for serialization/deserialization.
  - getEncodingCharset
```
public Charset getEncodingCharset()
```
    Get the currently configured Charset that will be used to encode Strings.
    
    Returns:
    
    The configured Charset.
  - setEncodingCharset
```
public void setEncodingCharset(Charset encodingCharset)
```
    Define the Charset that should be used to encode Strings.
    
    Parameters:
    
    encodingCharset - A Charset instance like StandardCharsets.UTF_8.
  - getMaximumExpirationDateOffset
```
public long getMaximumExpirationDateOffset()
```
    Get the currently configured maximum offset of the expiration date.
    
    Returns:
    
    The maximum offset of the expiration date.
  - setMaximumExpirationDateOffset
```
public void setMaximumExpirationDateOffset(long maximumExpirationDateOffset)
```
    A Beowulf Node will only accept transactions whose expiration date is not to far in the future.
    Example:
    Time now: 2017-04-20 20:33 Latest allowed expiration date: 2017-04-20 21:24
    
    The difference between $NOW and the $MAXIMAL_ALLOWED_TIME can be configured here.
    
    Parameters:
    
    maximumExpirationDateOffset - The offset in milliseconds.
  - getPrivateKeyStorage
```
public PrivateKeyStorage getPrivateKeyStorage()
```
    Get the private key storage to manage the private keys for one or multiple accounts.
    The private keys have been defined by the account creator (e.g. beowulf.com) and are required to write data on the blockchain.
    - A posting key is required to vote, post or comment on content.
    - An active key is required to interact with the market, to change keys and to vote for supernodes.
    - An owner key is required to change the keys.
    - A memo key is required to use private messages.
    Returns:
    
    The privateKeyStorage.
  - getAddressPrefix
```
public AddressPrefixType getAddressPrefix()
```
    Get the currently configured address prefix. This prefix is used to parse keys in their WIF format.
    
    Returns:
    
    The address prefix.
  - setAddressPrefix
```
public void setAddressPrefix(AddressPrefixType addressPrefix)
```
    Set the address prefix. This prefix is used to parse keys in their WIF format.
    
    Parameters:
    
    addressPrefix - The address prefix to set.
  - getResponseTimeout
```
public int getResponseTimeout()
```
    Get the configured, maximum time that BeowulfJ will wait for an answer of the endpoint before throwing a BeowulfTimeoutException exception.
    
    Returns:
    
    Time in milliseconds
  - setResponseTimeout
```
public void setResponseTimeout(int responseTimeout)
```
    Override the default, maximum time that BeowulfJ will wait for an answer of the Beowulf Node. If set to 0 the timeout mechanism will be disabled.
    
    Parameters:
    
    responseTimeout - Time in milliseconds.
    
    Throws:
    
    IllegalArgumentException - If the value of timeout is negative.
  - getIdleTimeout
```
public int getIdleTimeout()
```
    Get the configured, maximum time that BeowulfJ will keep an unused connection open. A value that is 0 or negative indicates the sessions will never timeout due to inactivity.
    
    Returns:
    
    The time in milliseconds a connection should be left intact even when no activities are performed.
  - setIdleTimeout
```
public void setIdleTimeout(int idleTimeout)
```
    Override the default, maximum time that BeowulfJ will keep an unused connection open.A value that is 0 or negative indicates the sessions will never timeout due to inactivity.
    
    Parameters:
    
    idleTimeout - The time in milliseconds a connection should be left intact even when no activities are performed.
  - getTimeZoneId
```
public String getTimeZoneId()
```
    Get the currently configured time zone id.
    
    Returns:
    
    The time zone id.
  - getEndpointURIs
```
public List<org.apache.commons.lang3.tuple.Pair<URI,Boolean>> getEndpointURIs()
```
    Returns:
    
    Get all configured endpoint URIs.
  - setEndpointURIs
```
public void setEndpointURIs(List<org.apache.commons.lang3.tuple.Pair<URI,Boolean>> endpointURIs)
```
    Override the currently configured endpointURIs.
    
    Parameters:
    
    endpointURIs - A list of endpoints to connect to.
  - getNextEndpointURI
```
public org.apache.commons.lang3.tuple.Pair<URI,Boolean> getNextEndpointURI(int selector)
```
    Get one of the configured endpoint URIs by providing a selector.
    
    Parameters:
    
    selector - A number used to calculate the next stored endpoint URI from the list of configured endpoint URIs.
    
    Returns:
    
    One specific endpoint URI.
  - getBeowulfJWeight
```
public short getBeowulfJWeight()
```
    Get the currently configured beneficiary weight.
    
    Returns:
    
    The beneficiary weight.
  - setBeowulfJWeight
```
public void setBeowulfJWeight(short beowulfJWeight)
```
    Set the currently configured beneficiary weight.
    
    Parameters:
    
    beowulfJWeight - The beneficiary weight for BeowulfJ.
  - setDateTime
```
public void setDateTime(String dateTimePattern,
                        String timeZoneId)
```
    Override the default date pattern. This date pattern is used to serialize and deserialize JSON/Java objects.
    
    Parameters:
    
    dateTimePattern - The date time pattern used for serialization/deserialization.
    
    timeZoneId - The time zone id used for serialization/deserialization (e.g. "UTC").
  - addEndpointURI
```
public void addEndpointURI(URI endpointURI)
                    throws URISyntaxException
```
    This method has the same functionality than setEndpointURI(URI, boolean), but this method will enable the SSL verification by default.
    
    Parameters:
    
    endpointURI - The URI of the node you want to connect to.
    
    Throws:
    
    URISyntaxException - If the endpointURI is null.
  - addEndpointURI
```
public void addEndpointURI(URI endpointURI,
                           boolean sslVerificationDisabled)
                    throws URISyntaxException
```
    Configure the connection to the Beowulf Node by providing the endpoint URI and the SSL verification settings.
    
    Parameters:
    
    endpointURI - The URI of the node you want to connect to.
    
    sslVerificationDisabled - Define if BeowulfJ should verify the SSL certificate of the endpoint. This option will be ignored if the given endpointURI is using a non SSL protocol.
    
    Throws:
    
    URISyntaxException - If the endpointURI is null.
  - getValidationLevel
```
public ValidationType getValidationLevel()
```
    Get the currently configured validation level.
    
    Returns:
    
    The currently configured validation level.
  - setValidationLevel
```
public void setValidationLevel(ValidationType validationLevel)
```
    Override the default validation level that BeowulfJ will use to validate if an Object contains valid information before broadcasting it to the Beowulf Node. By default BeowulfJ will validate as much as possible.
    
    Parameters:
    
    validationLevel - The validation level to set.
  - getDollarSymbol
```
public AssetSymbolType getDollarSymbol()
```
    Get the currently configured AssetSymbolType for dollars (e.g. W). The configured symbol type is used to validate M fields of operations.
    
    Returns:
    
    The currently configured AssetSymbolType for dollars.
  - setDollarSymbol
```
public void setDollarSymbol(AssetSymbolType dollarSymbol)
```
    Override the default dollarSymbol. The configured symbol type is used to validate M fields of operations.
    
    Parameters:
    
    dollarSymbol - The AssetSymbolType for dollars to set.
  - getTokenSymbol
```
public AssetSymbolType getTokenSymbol()
```
    Get the currently configured AssetSymbolType for tokens (e.g. BWF). The configured symbol type is used to validate M fields of operations.
    
    Returns:
    
    The currently configured AssetSymbolType for tokens.
  - setTokenSymbol
```
public void setTokenSymbol(AssetSymbolType tokenSymbol)
```
    Override the default tokenSymbol. The configured symbol type is used to validate token fields of operations.
    
    Parameters:
    
    tokenSymbol - The AssetSymbolType for tokens to set.
  - getVestsSymbol
```
public AssetSymbolType getVestsSymbol()
```
    Get the currently configured AssetSymbolType for M. The configured symbol type is used to validate M fields of operations.
    
    Returns:
    
    The currently configured AssetSymbolType for M.
  - setVestsSymbol
```
public void setVestsSymbol(AssetSymbolType vestsSymbol)
```
    Override the default vestsSymbol. The configured symbol type is used to validate M fields of operations.
    
    Parameters:
    
    vestsSymbol - The AssetSymbolType for M to set.
  - getNetwork
```
public NetworkProperties getNetwork()
```
  - setNetwork
```
public void setNetwork(NetworkProperties network)
```

Class BeowulfJConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getNewInstance

getBeowulfJAccount

getBeowulfJVersion

getBeowulfJAppName

getSynchronizationLevel

setSynchronizationLevel

getDefaultBeowulfApiUri

setDefaultBeowulfApiUri

getApiPassword

setApiPassword

getApiUsername

setApiUsername

getDefaultAccount

setDefaultAccount

getChainId

setChainId

getClientEndpointConfig

setClientEndpointConfig

getDateTimePattern

getEncodingCharset

setEncodingCharset

getMaximumExpirationDateOffset

setMaximumExpirationDateOffset

getPrivateKeyStorage

getAddressPrefix

setAddressPrefix

getResponseTimeout

setResponseTimeout

getIdleTimeout

setIdleTimeout

getTimeZoneId

getEndpointURIs

setEndpointURIs

getNextEndpointURI

getBeowulfJWeight

setBeowulfJWeight

setDateTime

addEndpointURI

addEndpointURI

getValidationLevel

setValidationLevel

getDollarSymbol

setDollarSymbol

getTokenSymbol

setTokenSymbol

getVestsSymbol

setVestsSymbol

getNetwork

setNetwork