Package org.yamcs.http.api

Class LinksApi

java.lang.Object

org.yamcs.protobuf.links.AbstractLinksApi<Context>

org.yamcs.http.api.LinksApi

All Implemented Interfaces:

Api<Context>

public class LinksApi
extends AbstractLinksApi<Context>

Constructor Summary

Constructors

Constructor	Description
LinksApi(AuditLog auditLog)

Method Summary

Modifier and Type	Method	Description
void	disableLink(Context ctx, DisableLinkRequest request, Observer<LinkInfo> observer)	Disable a link
void	enableLink(Context ctx, EnableLinkRequest request, Observer<LinkInfo> observer)	Enable a link
void	getLink(Context ctx, GetLinkRequest request, Observer<LinkInfo> observer)	Get a link
void	listLinks(Context ctx, ListLinksRequest request, Observer<ListLinksResponse> observer)	List links
void	resetLinkCounters(Context ctx, ResetLinkCountersRequest request, Observer<LinkInfo> observer)	Reset link counters
void	runAction(Context ctx, RunActionRequest request, Observer<com.google.protobuf.Struct> observer)	Run a link-specific action.
void	subscribeLinks(Context ctx, SubscribeLinksRequest request, Observer<LinkEvent> observer)	Receive link updates
void	updateLink(Context ctx, EditLinkRequest request, Observer<LinkInfo> observer)	Update a link
static Link	verifyLink(String instance, String linkName)

Methods inherited from class org.yamcs.protobuf.links.AbstractLinksApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

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

Constructor Details

LinksApi

public LinksApi(AuditLog auditLog)

Method Details

listLinks

public void listLinks(Context ctx,
 ListLinksRequest request,
 Observer<ListLinksResponse> observer)

Description copied from class: AbstractLinksApi

  List links
 

Specified by:

listLinks in class AbstractLinksApi<Context>

subscribeLinks

public void subscribeLinks(Context ctx,
 SubscribeLinksRequest request,
 Observer<LinkEvent> observer)

Description copied from class: AbstractLinksApi

  Receive link updates
 

Specified by:

subscribeLinks in class AbstractLinksApi<Context>

getLink

public void getLink(Context ctx,
 GetLinkRequest request,
 Observer<LinkInfo> observer)

Description copied from class: AbstractLinksApi

  Get a link
 

Specified by:

getLink in class AbstractLinksApi<Context>

enableLink

public void enableLink(Context ctx,
 EnableLinkRequest request,
 Observer<LinkInfo> observer)

Description copied from class: AbstractLinksApi

  Enable a link
 

Specified by:

enableLink in class AbstractLinksApi<Context>

disableLink

public void disableLink(Context ctx,
 DisableLinkRequest request,
 Observer<LinkInfo> observer)

Description copied from class: AbstractLinksApi

  Disable a link
 

Specified by:

disableLink in class AbstractLinksApi<Context>

resetLinkCounters

public void resetLinkCounters(Context ctx,
 ResetLinkCountersRequest request,
 Observer<LinkInfo> observer)

Description copied from class: AbstractLinksApi

  Reset link counters
 

Specified by:

resetLinkCounters in class AbstractLinksApi<Context>

updateLink

public void updateLink(Context ctx,
 EditLinkRequest request,
 Observer<LinkInfo> observer)

Description copied from class: AbstractLinksApi

  Update a link
 

Specified by:

updateLink in class AbstractLinksApi<Context>

runAction

public void runAction(Context ctx,
 RunActionRequest request,
 Observer<com.google.protobuf.Struct> observer)

Description copied from class: AbstractLinksApi

  Run a link-specific action.
 
  It is up to the link implementation to register and handle
  any link actions.
 

Specified by:

runAction in class AbstractLinksApi<Context>

verifyLink

public static Link verifyLink(String instance,
 String linkName)