MCPcopy Create free account

hub / github.com/Nike-Inc/riposte-microservice-template / types & classes

Types & classes38 in github.com/Nike-Inc/riposte-microservice-template

ClassAppEurekaGuiceModule
A Guice module for encapsulating Eureka stuff.
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppEurekaGuiceModule.java:18
ClassAppEurekaGuiceModuleTest
Tests the functionality of {@link AppEurekaGuiceModule}.
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppEurekaGuiceModuleTest.java:14
ClassAppGuiceModule
The main Guice module for the application. The {@link #validator()}, {@link #projectApiErrors()}, {@link #appInfoFuture(AsyncHttpClientHelper)}, and {
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppGuiceModule.java:51
ClassAppGuiceModuleTest
Tests the functionality of {@link AppGuiceModule}
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppGuiceModuleTest.java:35
ClassAppMetricsGuiceModule
A Guice module that initializes the various components of the Riposte metrics-gathering system. The main component that the application will want to i
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppMetricsGuiceModule.java:33
ClassAppMetricsGuiceModuleTest
Tests the functionality of {@link AppMetricsGuiceModule}.
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppMetricsGuiceModuleTest.java:46
ClassAppSecurityGuiceModule
A Guice module for encapsulating the configuration of the {@link RequestSecurityValidator} that the app will use.
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppSecurityGuiceModule.java:21
ClassAppServerConfig
The {@link ServerConfig} for this application. Many of the server config option values (e.g. {@link ServerConfig#endpointsPort()} come from your confi
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/AppServerConfig.java:45
ClassAppServerConfigForTesting
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/testutils/TestUtils.java:103
ClassAppServerConfigTest
Tests the functionality of {@link AppServerConfig}
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/server/config/AppServerConfigTest.java:44
ClassApplicationJsr303AnnotationTroller
Extension of {@link ReflectionBasedJsr303AnnotationTrollerBase} for use with this project. This is used by JSR 303 annotation convention enforcement t
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/backstopper/apierror/contract/jsr303convention/ApplicationJsr303AnnotationTroller.java:23
ClassBasicAuthVerificationFunctionalTest
Functional test that verifies the server is correctly restricting access via basic auth. <p>TODO: EXAMPLE CLEANUP - If your app does not use any secu
riposte-microservice-template-remote-tests/src/test/java/com/myorg/ripostemicroservicetemplate/functionaltest/BasicAuthVerificationFunctionalTest.java:22
ClassErrorHandlingEndpointArgs
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleEndpoint.java:147
ClassEurekaServerHooks
Class holding the Riposte server startup and shutdown hooks that will startup and shutdown Eureka registration. These hooks should be returned by the
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/AppEurekaGuiceModule.java:53
ClassExampleBasicAuthProtectedEndpoint
A set of example endpoints that show the Riposte security validation system in action (using basic auth since it's easy to understand). <pre> <ul>
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleBasicAuthProtectedEndpoint.java:52
ClassExampleDownstreamHttpAsyncEndpoint
Contains an example of how to do asynchronous downstream HTTP calls so that the thread count on the server stays constant even when it's being hammere
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleDownstreamHttpAsyncEndpoint.java:37
ClassExampleEndpoint
An example endpoint that shows how to do automatic and manual validation (in the {@link Post} inner class). <p>The automatic validation is done becau
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleEndpoint.java:49
ClassExampleProxyRouterEndpoint
An example of the proxy/router functionality. Since we want the examples to be fully self-contained we simply make a downstream call to our own {@link
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleProxyRouterEndpoint.java:32
ClassGet
The GET implementation of /example
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleEndpoint.java:57
ClassGet
The GET implementation of /exampleBasicAuth
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleBasicAuthProtectedEndpoint.java:59
ClassGuiceProvidedServerConfigValues
An extension of {@link DependencyInjectionProvidedServerConfigValuesBase} that includes all the extra dependency-injected properties needed by {@link
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/server/config/guice/GuiceProvidedServerConfigValues.java:26
ClassHealthCheckEndpoint
Dummy health check endpoint. This will immediately respond with a 200 HTTP status code. It will let you know when your machine has fallen over but not
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/HealthCheckEndpoint.java:19
ClassHealthCheckEndpointTest
Verifies the functionality of {@link HealthCheckEndpoint}
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/endpoints/HealthCheckEndpointTest.java:19
ClassMain
Main class entry point for this app. Sets up Typesafe Config and initializes a new Riposte {@link Server} with the application's {@link ServerConfig}.
riposte-microservice-template-core-code/src/main/java/com/myorg/Main.java:14
ClassMainTest
Tests the functionality of {@link Main}.
riposte-microservice-template-core-code/src/test/java/com/myorg/MainTest.java:23
ClassObjectHolder
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleDownstreamHttpAsyncEndpoint.java:100
ClassPost
The POST implementation of /example
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleEndpoint.java:90
ClassPost
The POST implementation of /exampleBasicAuth
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/endpoints/ExampleBasicAuthProtectedEndpoint.java:99
EnumProjectApiError
Contains the application-specific errors that can occur. Each enum value maps an application-specific error to the appropriate HTTP status code, and c
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/error/ProjectApiError.java:29
ClassProjectApiErrorsImpl
Returns the project specific errors for this application. <p>Individual projects should feel free to rename this class to something specific, e.g. [M
riposte-microservice-template-core-code/src/main/java/com/myorg/ripostemicroservicetemplate/error/ProjectApiErrorsImpl.java:21
ClassProjectApiErrorsImplTest
Unit tests the ProjectApiErrorsImpl class. The real tests live in {@link ProjectApiErrorsTestBase} (which this test class extends), and are picked up
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/error/ProjectApiErrorsImplTest.java:17
ClassPropertiesHelper
Helper that automates the extraction of functional test properties from the appropriate properties files and provides a few helper methods like {@link
riposte-microservice-template-remote-tests/src/test/java/com/myorg/ripostemicroservicetemplate/functionaltest/PropertiesHelper.java:28
ClassTestUtils
Contains static helper methods for performing some common test tasks, mainly around launching a real server to test against ({@link #createServerForTe
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/testutils/TestUtils.java:28
ClassTypesafeConfigPropertiesRegistrationGuiceModuleForTesting
An extension of {@link TypesafeConfigPropertiesRegistrationGuiceModule} that forces Typesafe Config to be loaded with the given app ID and environment
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/testutils/TypesafeConfigPropertiesRegistrationGuiceModuleForTesting.java:13
ClassVerifyBasicAuthIsConfiguredCorrectlyComponentTest
Component test that verifies the basic auth security is configured correctly on the server. <p>TODO: EXAMPLE CLEANUP - If your app does not use any s
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/componenttest/VerifyBasicAuthIsConfiguredCorrectlyComponentTest.java:30
ClassVerifyExampleEndpointComponentTest
Component test that launches a test version of the application that uses a "compiletimetest" properties file for its environment but is otherwise iden
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/componenttest/VerifyExampleEndpointComponentTest.java:36
ClassVerifyJsr303ContractTest
Verifies that ALL non-excluded JSR 303 validation annotations in this project have a message defined that maps to a {@link com.nike.backstopper.apierr
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/backstopper/apierror/contract/jsr303convention/VerifyJsr303ContractTest.java:20
ClassVerifyStringConvertsToClassTypeAnnotationsAreValidTest
Makes sure that any Enums referenced by {@link StringConvertsToClassType} JSR 303 annotations are case insensitive if they are marked with {@link Stri
riposte-microservice-template-core-code/src/test/java/com/myorg/ripostemicroservicetemplate/backstopper/apierror/contract/jsr303convention/VerifyStringConvertsToClassTypeAnnotationsAreValidTest.java:16