org.yamcs.api

Class YamcsConnectionProperties

java.lang.Object

org.yamcs.api.YamcsConnectionProperties

public class YamcsConnectionProperties
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YamcsConnectionProperties.Protocol

Constructor Summary

Constructors

Constructor and Description
YamcsConnectionProperties()
YamcsConnectionProperties(String host, int port)
YamcsConnectionProperties(String host, int port, AuthenticationToken authToken)
YamcsConnectionProperties(String host, int port, String instance)

Method Summary

Modifier and Type	Method and Description
YamcsConnectionProperties	clone()
AuthenticationToken	getAuthenticationToken()
String	getHost()
String	getInstance()
int	getPort()
YamcsConnectionProperties.Protocol	getProtocol()
String	getRestApiUrl() Return the base REST API URL for connecting to yamcs
String	getUrl()
void	load()
static YamcsConnectionProperties	parse(String uri) uri is protocol://[[username]:[password]@][host[:port]]/[instance]
void	save()
void	setAuthenticationToken(AuthenticationToken authToken)
void	setHost(String host)
void	setInstance(String instance)
void	setPort(int port)
void	setProtocol(YamcsConnectionProperties.Protocol protocol)
void	setSsl(boolean ssl)
URI	webResourceURI(String relativePath)
URI	webSocketURI()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YamcsConnectionProperties

public YamcsConnectionProperties()

YamcsConnectionProperties

public YamcsConnectionProperties(String host,
                                 int port,
                                 String instance)

YamcsConnectionProperties

public YamcsConnectionProperties(String host,
                                 int port)

YamcsConnectionProperties

public YamcsConnectionProperties(String host,
                                 int port,
                                 AuthenticationToken authToken)

Method Detail

getHost

public String getHost()

getPort

public int getPort()

getInstance

public String getInstance()

webResourceURI

public URI webResourceURI(String relativePath)

webSocketURI

public URI webSocketURI()

load

public void load()

save

public void save()

setInstance

public void setInstance(String instance)

setSsl

public void setSsl(boolean ssl)

setProtocol

public void setProtocol(YamcsConnectionProperties.Protocol protocol)

clone

public YamcsConnectionProperties clone()

Overrides:

clone in class Object

setHost

public void setHost(String host)

setPort

public void setPort(int port)

getRestApiUrl

public String getRestApiUrl()

Return the base REST API URL for connecting to yamcs

Returns:

A sting of the shape http://host:port/api

getAuthenticationToken

public AuthenticationToken getAuthenticationToken()

setAuthenticationToken

public void setAuthenticationToken(AuthenticationToken authToken)

parse

public static YamcsConnectionProperties parse(String uri)
                                       throws URISyntaxException

uri is protocol://[[username]:[password]@][host[:port]]/[instance]

Parameters:

uri -

Returns:

an object containing the connection properties

Throws:

URISyntaxException

getProtocol

public YamcsConnectionProperties.Protocol getProtocol()

getUrl

public String getUrl()