Package ru.vyarus.dropwizard.guice.test.rest

Class RestStubsHook.Builder

  • Enclosing class:
    RestStubsHook
    public static class RestStubsHook.Builder
extends java.lang.Object
    Rest stubs configuration builder.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • resources

        public RestStubsHook.Builder resources​(java.lang.Class<?>... resources)
        By default, all resources would be available. Use this option to run a subset of resources.
        Parameters:
        resources - resources to use in staub
        Returns:
        builder instance for chained calls
        See Also:
        to disable some default resources

      • disableResources

        public RestStubsHook.Builder disableResources​(java.lang.Class<?>... disableResources)
        NOTE: if resources specified in resources(Class[]) then the disable option would be ignored (all required resources already specified). This option is useful to exclude only some resources from the registered application resources

        Important: affects only resources, recognized as guicey extensions. Manually registered resources would remain!

        Parameters:
        disableResources - resources to disable
        Returns:
        builder instance for chained calls

      • jerseyExtensions

        public RestStubsHook.Builder jerseyExtensions​(java.lang.Class<?>... jerseyExtensions)
        By default, all jersey extension, registered in application, would be registered. Use this option to specify exact required extensions (all other application extensions would be disabled).

        Important: this affects only guicey extensions (all other guicey extension would be simply disabled). To disable core dropwizard exception mappers use disableDropwizardExceptionMappers(boolean).

        Parameters:
        jerseyExtensions - jersey extensions to use in stub
        Returns:
        builder instance for chained calls

      • disableAllJerseyExtensions

        public RestStubsHook.Builder disableAllJerseyExtensions​(boolean disableAllJerseyExtensions)
        NOTE: if extensions specified in jerseyExtensions(Class[]) then the disable option would be ignored (all required extensions already specified).

        Does not affect dropwizard default extensions (only affects extension, controlled by guicey). Dropwizard exception mappers could be disabled with disableDropwizardExceptionMappers(boolean) ()}.

        Parameters:
        disableAllJerseyExtensions - true to disable all application jersey extensions
        Returns:
        builder instance for chained calls

      • disableDropwizardExceptionMappers

        public RestStubsHook.Builder disableDropwizardExceptionMappers​(boolean disableDropwizardExceptionMappers)
        By default, all dropwizard exception mappers registered (same as in real application). For tests, it might be more convenient to disable them and receive direct exception objects after test.
        Parameters:
        disableDropwizardExceptionMappers - true dropwizard exception mappers
        Returns:
        builder instance for chained calls

      • disableJerseyExtensions

        public RestStubsHook.Builder disableJerseyExtensions​(java.lang.Class<?>... disableJerseyExtensions)
        NOTE: if extensions specified in jerseyExtensions(Class[]) then the disable option would be ignored (all required extensions already specified). This option is useful to exclude only some extensions from the registered application jersey extensions.

        Does not affect dropwizard default extensions (only affects extension, controlled by guicey). Dropwizard exception mappers could be disabled with disableDropwizardExceptionMappers(boolean).

        Parameters:
        disableJerseyExtensions - jersey extensions to disable
        Returns:
        builder instance for chained calls

      • logRequests

        public RestStubsHook.Builder logRequests​(boolean logRequests)
        Requests log enabled by default (like in ClientSupport).
        Parameters:
        logRequests - true to print all requests and responses into console
        Returns:
        builder instance for chained calls

      • container

        public RestStubsHook.Builder container​(TestContainerPolicy policy)
        By default, use a lightweight in-memory container, but switch to grizzly when it's available in classpath (this is the default behavior of JerseyTest).
        Parameters:
        policy - required test container policy
        Returns:
        builder instance for chained calls