Package com.netflix.eureka.resources

Class ApplicationsResource

  • @Path("/{version}/apps")
@Produces({"application/xml","application/json"})
public class ApplicationsResource
extends java.lang.Object
    A jersey resource that handles request related to all Applications.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApplicationResource getApplicationResource​(java.lang.String version, java.lang.String appId)
      Gets information about a particular Application.
      jakarta.ws.rs.core.Response getContainerDifferential​(java.lang.String version, java.lang.String acceptHeader, java.lang.String acceptEncoding, java.lang.String eurekaAccept, jakarta.ws.rs.core.UriInfo uriInfo, java.lang.String regionsStr)
      Get information about all delta changes in Applications.
      jakarta.ws.rs.core.Response getContainers​(java.lang.String version, java.lang.String acceptHeader, java.lang.String acceptEncoding, java.lang.String eurekaAccept, jakarta.ws.rs.core.UriInfo uriInfo, java.lang.String regionsStr)
      Get information about all Applications.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ApplicationsResource

        public ApplicationsResource()

    • Method Detail

      • getApplicationResource

        @Path("{appId}")
public ApplicationResource getApplicationResource​(@PathParam("version")
                                                  java.lang.String version,
                                                  @PathParam("appId")
                                                  java.lang.String appId)
        Gets information about a particular Application.
        Parameters:
        version - the version of the request.
        appId - the unique application identifier (which is the name) of the application.
        Returns:
        information about a particular application.

      • getContainers

        @GET
public jakarta.ws.rs.core.Response getContainers​(@PathParam("version")
                                                 java.lang.String version,
                                                 @HeaderParam("Accept")
                                                 java.lang.String acceptHeader,
                                                 @HeaderParam("Accept-Encoding")
                                                 java.lang.String acceptEncoding,
                                                 @HeaderParam("X-Eureka-Accept")
                                                 java.lang.String eurekaAccept,
                                                 @Context
                                                 jakarta.ws.rs.core.UriInfo uriInfo,
                                                 @Nullable @QueryParam("regions")
                                                 java.lang.String regionsStr)
        Get information about all Applications.
        Parameters:
        version - the version of the request.
        acceptHeader - the accept header to indicate whether to serve JSON or XML data.
        acceptEncoding - the accept header to indicate whether to serve compressed or uncompressed data.
        eurekaAccept - an eureka accept extension, see EurekaAccept
        uriInfo - the URI information of the request made.
        regionsStr - A comma separated list of remote regions from which the instances will also be returned. The applications returned from the remote region can be limited to the applications returned by EurekaServerConfig.getRemoteRegionAppWhitelist(String)
        Returns:
        a response containing information about all Applications from the AbstractInstanceRegistry.

      • getContainerDifferential

        @Path("delta")
@GET
public jakarta.ws.rs.core.Response getContainerDifferential​(@PathParam("version")
                                                            java.lang.String version,
                                                            @HeaderParam("Accept")
                                                            java.lang.String acceptHeader,
                                                            @HeaderParam("Accept-Encoding")
                                                            java.lang.String acceptEncoding,
                                                            @HeaderParam("X-Eureka-Accept")
                                                            java.lang.String eurekaAccept,
                                                            @Context
                                                            jakarta.ws.rs.core.UriInfo uriInfo,
                                                            @Nullable @QueryParam("regions")
                                                            java.lang.String regionsStr)
        Get information about all delta changes in Applications.

        The delta changes represent the registry information change for a period as configured by EurekaServerConfig.getRetentionTimeInMSInDeltaQueue(). The changes that can happen in a registry include Registrations,Cancels,Status Changes and Expirations. Normally the changes to the registry are infrequent and hence getting just the delta will be much more efficient than getting the complete registry.

        Since the delta information is cached over a period of time, the requests may return the same data multiple times within the window configured by EurekaServerConfig.getRetentionTimeInMSInDeltaQueue().The clients are expected to handle this duplicate information.

        Parameters:
        version - the version of the request.
        acceptHeader - the accept header to indicate whether to serve JSON or XML data.
        acceptEncoding - the accept header to indicate whether to serve compressed or uncompressed data.
        eurekaAccept - an eureka accept extension, see EurekaAccept
        uriInfo - the URI information of the request made.
        Returns:
        response containing the delta information of the AbstractInstanceRegistry.