org.rvpf.http

Interface HTTPSupport

public interface HTTPSupport

HTTP Support.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASIC_AUTHENTICATOR Basic authenticator.
static String	CERTIFICATE_AUTHENTICATOR Certificate authenticator.
static String	DIGEST_AUTHENTICATOR Digest authenticator.

Method Summary

Modifier and Type	Method and Description
void	destroyServer() Destroys the server.
Optional<String>	getListenerAddress(int index) Gets the listener address.
int	getListenerCount() Gets the listener count.
int	getListenerPort(int index) Gets the listener port.
boolean	isServerStarted() Asks if the server is started.
boolean	setUpContext(String path, Optional<String> resource, Map<String,String> servlets, Optional<String> realmName, Optional<String> authenticator, boolean confidential, String[] roles, Optional<EventListener> eventListener) Sets up a context.
boolean	setUpListener(String address, int port, int confidentialPort, Optional<ServerSecurityContext> securityContext) Sets up a listener.
boolean	setUpRealm(String realmName, KeyedGroups realmProperties, SecurityContext securityContext) Sets up a realm.
boolean	setUpServer(HTTPServerAppImpl httpServerAppImpl) Sets up the server.
void	startServer() Starts the server.
void	stopServer() Stops the server.

Field Detail

BASIC_AUTHENTICATOR

static final String BASIC_AUTHENTICATOR

Basic authenticator.

See Also:

Constant Field Values

CERTIFICATE_AUTHENTICATOR

static final String CERTIFICATE_AUTHENTICATOR

Certificate authenticator.

See Also:

Constant Field Values

DIGEST_AUTHENTICATOR

static final String DIGEST_AUTHENTICATOR

Digest authenticator.

See Also:

Constant Field Values

Method Detail

destroyServer

void destroyServer()
            throws Exception

Destroys the server.

Throws:

Exception - Thrown by the server.

getListenerAddress

@Nonnull
 @CheckReturnValue
Optional<String> getListenerAddress(int index)

Gets the listener address.

Parameters:

index - The listener index.

Returns:

The optional listener address.

getListenerCount

@CheckReturnValue
int getListenerCount()

Gets the listener count.

Returns:

The listener count.

getListenerPort

@CheckReturnValue
int getListenerPort(int index)

Gets the listener port.

Parameters:

index - The listener index.

Returns:

The listener port.

isServerStarted

@CheckReturnValue
boolean isServerStarted()

Asks if the server is started.

Returns:

True if the server is started.

setUpContext

@CheckReturnValue
boolean setUpContext(@Nonnull
                                        String path,
                                        @Nonnull
                                        Optional<String> resource,
                                        @Nonnull
                                        Map<String,String> servlets,
                                        @Nonnull
                                        Optional<String> realmName,
                                        @Nonnull
                                        Optional<String> authenticator,
                                        boolean confidential,
                                        @Nonnull
                                        String[] roles,
                                        @Nonnull
                                        Optional<EventListener> eventListener)

Sets up a context.

Parameters:

path - The context path.

resource - The optional resource base.

servlets - The servlets map.

realmName - The optional realm name.

authenticator - The optional authenticator identification.

confidential - Confidential channel needed.

roles - The allowed roles (may be empty).

eventListener - The optional context event listener.

Returns:

True on success.

setUpListener

@CheckReturnValue
boolean setUpListener(@Nonnull
                                         String address,
                                         int port,
                                         int confidentialPort,
                                         @Nonnull
                                         Optional<ServerSecurityContext> securityContext)

Sets up a listener.

Parameters:

address - The host interface address.

port - The interface port.

confidentialPort - A confidential port.

securityContext - An optional security context.

Returns:

True on success.

setUpRealm

@CheckReturnValue
boolean setUpRealm(@Nonnull
                                      String realmName,
                                      @Nonnull
                                      KeyedGroups realmProperties,
                                      @Nonnull
                                      SecurityContext securityContext)

Sets up a realm.

Parameters:

realmName - The realm name.

realmProperties - The the realm configuration properties.

securityContext - The security context.

Returns:

True on success.

setUpServer

@CheckReturnValue
boolean setUpServer(@Nonnull
                                       HTTPServerAppImpl httpServerAppImpl)

Sets up the server.

Parameters:

httpServerAppImpl - The HTTP server application implementation.

Returns:

True on success.

startServer

void startServer()
          throws Exception

Starts the server.

Throws:

Exception - Thrown by the server.

stopServer

void stopServer()
         throws Exception

Stops the server.

Throws:

Exception - Thrown by the server.