Package com.luciad.fusion.platform.model

Class TLfnService

java.lang.Object
com.luciad.fusion.platform.model.TLfnService
public final class TLfnService extends Object

Represents a service that is available in LuciadFusion Studio.

A service makes geospatial data available to clients. Clients send requests to the endpoint path of the service.

Only one service exists for a given type and name. A client uses the type and name to specify which service it wants to connect to.

The type of the service determines the protocol on how the geospatial data is made available to clients. Some examples are: WMS, WMTS, WCS, WFS.

Implement ILfnServiceTypeConfiguration to add your own service type to LuciadFusion.

Use the TLfnServiceRepository to query the services available in LuciadFusion Studio. Use the TLfnProductRepository to query the products published in a service.

Since:
2021.0

  • Method Details

    • getId

      public String getId()
      Returns the identifier of the service. The id is unique among all service.

      Use id to look up information related to a certain service. For example, use the id of a TLfnService to find the TLfnProduct resources published in that service using the TLfnProductRepository.findByServiceId(String) method.

      Returns:
      the identifier of the data.

    • getTitle

      public String getTitle()
      Returns the human-readable title of the service.
      Returns:
      the title of the service

    • getName

      public String getName()
      Returns the machine-readable name of the service. Only one service exists for a given type and name.
      Returns:
      the name of the service

    • getType

      public String getType()
      Returns the service type. Example: wms for a WMS service.
      Returns:
      the service type

    • getAbstractText

      public String getAbstractText()
      Returns the abstract text describing the service.
      Returns:
      the abstract text describing the service

    • getKeywords

      public Set<String> getKeywords()
      Returns the set of keywords associated with the service.
      Returns:
      the keywords associated with the service

    • getStatus

      public ELfnServiceStatus getStatus()
      Returns the current status of the service.
      Returns:
      the current status of the service

    • getCreatedBy

      public TLfnUser getCreatedBy()
      Returns the user who created this service.
      Returns:
      the TLfnUser who created this service
      Since:
      2022.1

    • getUpdatedBy

      public TLfnUser getUpdatedBy()
      Returns the user who last updated this service.
      Returns:
      the TLfnUser who last updated this service
      Since:
      2022.1

    • getCreationTime

      public ZonedDateTime getCreationTime()
      Returns the date and time when the service was created.
      Returns:
      date and time the service was created

    • getUpdateTime

      public ZonedDateTime getUpdateTime()
      Returns the date and time when the service was last updated. This is never null.
      Returns:
      date and time the service was last updated

    • getStartedTime

      public ZonedDateTime getStartedTime()
      Returns the date and time the service was last started. This returns null if the service has never been started yet.
      Returns:
      the date and time the service was last started

    • getVersion

      public Long getVersion()
      Returns the version of the service.

      The version is increased every time a change is made to the service, such as updating the title or adding a product to the service. The version can be used to determine if cache information related to the service needs to be invalidated. Store the version when the cache is created and check if the version has increased when accessing the cache.

      Certain services, such as WMS and WFS services, advertise the version as the update sequence number in the capabilities of the service.

      Returns:
      the version of the service

    • equals

      public boolean equals(Object aO)
      Indicates whether some other object is "equal to" this TLfnService. If the other object is also an TLfnService, the service ids will be compared, false is returned otherwise.
      Overrides:
      equals in class Object
      Returns:
      {true} is the other object is equal to this job, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object