Package io.openems.backend.uiwebsocket.impl

Class WsData

java.lang.Object
io.openems.common.websocket.WsData
io.openems.backend.uiwebsocket.impl.WsData
public class WsData extends WsData

  • Constructor Details

  • Method Details

    • logout

      public void logout()
      Logout and invalidate Session.

    • setUserId

      public void setUserId(String userId)

    • unsetUserId

      public void unsetUserId()
      Unsets the User-Token.

    • getUserId

      public Optional<String> getUserId()
      Gets the authenticated User-ID.
      Returns:
      the User-ID or Optional.Empty if the User was not authenticated.

    • getUser

      public Optional<User> getUser(Metadata metadata)
      Gets the authenticated User.
      Parameters:
      metadata - the Metadata service
      Returns:
      the User or Optional.Empty if the User was not authenticated or it is not available from Metadata service

    • setToken

      public void setToken(String token)

    • getToken

      public Optional<String> getToken()
      Gets the Login-Token.
      Returns:
      the Login-Token

    • unsetToken

      public void unsetToken()
      Unsets the Login-Token.

    • assertToken

      public String assertToken() throws OpenemsError.OpenemsNamedException
      Gets the token or throws an error if no token was set.
      Returns:
      the token
      Throws:
      OpenemsError.OpenemsNamedException - if no token has been set

    • toString

      public String toString()
      Description copied from class: WsData
      Provides a specific toString method.
      Specified by:
      toString in class WsData
      Returns:
      a specific string for this instance

    • handleSubscribeChannelsRequest

      public void handleSubscribeChannelsRequest(String edgeId, SubscribeChannelsRequest request)
      Applies a SubscribeChannelsRequest.
      Parameters:
      edgeId - the Edge-ID
      request - the SubscribeChannelsRequest

    • handleSubscribeEdgesRequest

      public void handleSubscribeEdgesRequest(Set<String> edgeIds)
      Applies a SubscribeEdgesRequest.
      Parameters:
      edgeIds - the edges to subscribe

    • sendSubscribedChannels

      public void sendSubscribedChannels(String edgeId, EdgeCache edgeCache)
      Sends the subscribed Channels to the UI session.
      Parameters:
      edgeId - the Edge-ID
      edgeCache - the EdgeCache for the Edge-ID

    • isEdgeSubscribed

      public boolean isEdgeSubscribed(String edgeId)
      Is the given Edge subscribed by this UI session?.
      Parameters:
      edgeId - the Edge-ID
      Returns:
      true if subscribed