All Downloads are FREE. Search and download functionalities are using the official Maven repository.

public.javadoc.org.spincast.plugins.undertow.SpincastUndertowServer.html Maven / Gradle / Ivy

There is a newer version: 0.9.28
Show newest version






SpincastUndertowServer (org.spincast:spincast-framework 0.9.21 API)












org.spincast.plugins.undertow

Class SpincastUndertowServer

  • All Implemented Interfaces:
    IServer


    public class SpincastUndertowServer
    extends Object
    implements IServer
    Server implementation for Undertow.
    • Field Detail

      • logger

        protected final org.slf4j.Logger logger
      • UNDERTOW_EXCEPTION_CODE_REQUEST_TOO_LARGE

        public static final String UNDERTOW_EXCEPTION_CODE_REQUEST_TOO_LARGE
        See Also:
        Constant Field Values
    • Method Detail

      • getHttpAuthActiveRealms

        protected Map<String,String> getHttpAuthActiveRealms()
      • getHttpAuthenticationRealms

        public Map<String,String> getHttpAuthenticationRealms()
        Description copied from interface: IServer
        Returns the existing HTTP authentication realms, the key being the realm's name and the value being the prefix path associated to this realm.

        The map is immutable.

        Specified by:
        getHttpAuthenticationRealms in interface IServer
      • getFormParserFactory

        protected io.undertow.server.handlers.form.FormParserFactory getFormParserFactory()
      • start

        public void start()
        Description copied from interface: IServer
        Starts the server.
        Specified by:
        start in interface IServer
      • getServerStartTryNbr

        protected int getServerStartTryNbr()
      • getStartServerSleepMilliseconds

        protected long getStartServerSleepMilliseconds()
      • getServerBuilder

        protected io.undertow.Undertow.Builder getServerBuilder()
      • addHttpListener

        protected void addHttpListener(io.undertow.Undertow.Builder builder,
                                       String serverHost,
                                       int httpServerPort)
      • addHttpsListener

        protected void addHttpsListener(io.undertow.Undertow.Builder builder,
                                        String serverHost,
                                        int httpsServerPort)
      • addBuilderOptions

        protected io.undertow.Undertow.Builder addBuilderOptions(io.undertow.Undertow.Builder builder)
      • getFinalHandler

        protected io.undertow.server.HttpHandler getFinalHandler()
        The very first handler considered by Undertow.
      • getHttpAuthenticationHandler

        protected io.undertow.server.handlers.PathHandler getHttpAuthenticationHandler()
        Handler to check for HTTP authentication requirement.
      • getHttpAuthHandlerNextHandler

        protected io.undertow.server.HttpHandler getHttpAuthHandlerNextHandler()
      • createHttpAuthenticationRealm

        public void createHttpAuthenticationRealm(String pathPrefix,
                                                  String realmName)
        Description copied from interface: IServer
        Creates HTTP authentication protection (realm) for the specified path prefix.
        Specified by:
        createHttpAuthenticationRealm in interface IServer
        realmName - The name of the realm. Must be unique on this server, otherwise an exception is thrown. This allows the application to add user to the realm using its name.
      • getRealmNameToDisplay

        protected String getRealmNameToDisplay(String pathPrefix,
                                               String realmName)
        The realm name to display.
      • removeHttpAuthentication

        public void removeHttpAuthentication(String username,
                                             String realmName)
        Description copied from interface: IServer
        Removes a user to an HTTP protected realm.
        Specified by:
        removeHttpAuthentication in interface IServer
      • removeHttpAuthentication

        public void removeHttpAuthentication(String username)
        Description copied from interface: IServer
        Removes a user from all HTTP protected realms.
        Specified by:
        removeHttpAuthentication in interface IServer
      • getSpincastFrontControllerHandler

        protected io.undertow.server.HttpHandler getSpincastFrontControllerHandler()
      • stop

        public void stop()
        Description copied from interface: IServer
        Stops the server
        Specified by:
        stop in interface IServer
      • sendWebsocketEnpointsClosedWhenServerStops

        protected void sendWebsocketEnpointsClosedWhenServerStops()
      • getStaticResourcesPathHandler

        protected io.undertow.server.handlers.PathHandler getStaticResourcesPathHandler()
      • removeAllStaticResourcesServed

        public void removeAllStaticResourcesServed()
        Description copied from interface: IServer
        Removes all static resources served directly by the server.
        Specified by:
        removeAllStaticResourcesServed in interface IServer
      • castExchange

        protected io.undertow.server.HttpServerExchange castExchange(Object exchange)
      • getFullUrl

        public String getFullUrl(Object exchangeObj)
        Description copied from interface: IServer
        The full encoded URL of the original request, including the queryString. Even if the request is forwarded elsewhere in the framework, this URL won't change, it will still be the original one.
        Specified by:
        getFullUrl in interface IServer
      • setResponseHeader

        public void setResponseHeader(Object exchangeObj,
                                      String name,
                                      List<String> values)
        Description copied from interface: IServer
        Sets a response header. Override any existing one with the same name.
        Specified by:
        setResponseHeader in interface IServer
      • setResponseStatusCode

        public void setResponseStatusCode(Object exchange,
                                          int statusCode)
        Description copied from interface: IServer
        Sets the response status code.
        Specified by:
        setResponseStatusCode in interface IServer
      • getDoNothingCallback

        protected io.undertow.io.IoCallback getDoNothingCallback()
      • getCloseExchangeCallback

        protected io.undertow.io.IoCallback getCloseExchangeCallback()
      • flushBytes

        public void flushBytes(Object exchange,
                               byte[] bytes,
                               boolean end)
        Description copied from interface: IServer
        Flushes some bytes to the response.
        Specified by:
        flushBytes in interface IServer
        end - if true, the exchange will be closed and nothing more can be send.
      • end

        public void end(Object exchange)
        Description copied from interface: IServer
        Ends the exchange. Nothing more can be send.
        Specified by:
        end in interface IServer
      • isResponseClosed

        public boolean isResponseClosed(Object exchange)
        Description copied from interface: IServer
        Is the response closed?
        Specified by:
        isResponseClosed in interface IServer
      • isResponseHeadersSent

        public boolean isResponseHeadersSent(Object exchange)
        Description copied from interface: IServer
        Are the response headers sent?
        Specified by:
        isResponseHeadersSent in interface IServer
      • getRequestScheme

        public String getRequestScheme(Object exchange)
        Description copied from interface: IServer
        Gets the request scheme, "http" for example.
        Specified by:
        getRequestScheme in interface IServer
      • getCookieEncoding

        protected String getCookieEncoding()
      • getFormData

        protected io.undertow.server.handlers.form.FormData getFormData(io.undertow.server.HttpServerExchange exchange)
        May return NULL.
      • getWebsocketEndpointCreationLock

        protected Object getWebsocketEndpointCreationLock(String endpointId)
        Gets the creation/close lock for a specific Websocket endpoint.
      • websocketCloseEndpoint

        public void websocketCloseEndpoint(String endpointId)
        Description copied from interface: IServer
        Closes a Websocket endpoint. No more connections will be accepter
        Specified by:
        websocketCloseEndpoint in interface IServer
      • websocketCloseEndpoint

        public void websocketCloseEndpoint(String endpointId,
                                           int closingCode,
                                           String closingReason)
        Description copied from interface: IServer
        Closes the entire Websocket endpoint. All peer connections of this endpoint will be closed.
        Specified by:
        websocketCloseEndpoint in interface IServer
        closingCode - The closing code.
        closingReason - The closing reason.
      • websocketConnection

        public void websocketConnection(Object exchangeObj,
                                        String endpointId,
                                        String peerId)
        Description copied from interface: IServer
        Transforms the request to a peer Websocket connection on the endpoint 'endpointId'.
        Specified by:
        websocketConnection in interface IServer

Copyright © 2016. All rights reserved.





© 2015 - 2025 Weber Informatics LLC | Privacy Policy