Package fish.payara.microprofile.openapi.impl.admin

Interface OpenApiServiceConfiguration

All Superinterfaces:

ConfigBeanProxy, ConfigExtension, Container

public interface OpenApiServiceConfiguration
extends ConfigExtension

Configuration for the OpenAPI Service.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

ConfigBeanProxy.Duck

Method Summary

Modifier and Type	Method	Description
String	getCorsHeaders()	Defines if CORS headers are set on the OpenApi response.
String	getEnabled()
String	getEndpoint()
String	getRoles()
String	getSecurityEnabled()
String	getVirtualServers()
void	setCorsHeaders(String value)
void	setEnabled(String value)
void	setEndpoint(String value)
void	setRoles(String value)
void	setSecurityEnabled(String value)
void	setVirtualServers(String value)

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Method Detail

getEnabled

String getEnabled()

Returns:

whether the service is enabled or not.

setEnabled

void setEnabled(String value)
         throws PropertyVetoException

Throws:

PropertyVetoException

getEndpoint

String getEndpoint()

Returns:

a String value defines the endpoint of openapi service.

setEndpoint

void setEndpoint(String value)
          throws PropertyVetoException

Throws:

PropertyVetoException

getCorsHeaders

String getCorsHeaders()

Defines if CORS headers are set on the OpenApi response.

Returns:

whether to set CORS headers or not

setCorsHeaders

void setCorsHeaders(String value)
             throws PropertyVetoException

Throws:

PropertyVetoException

getVirtualServers

String getVirtualServers()

Returns:

a String value defines the attached virtual servers.

setVirtualServers

void setVirtualServers(String value)
                throws PropertyVetoException

Throws:

PropertyVetoException

getSecurityEnabled

String getSecurityEnabled()

Returns:

a Boolean value determining if the security is enabled or not.

setSecurityEnabled

void setSecurityEnabled(String value)
                 throws PropertyVetoException

Throws:

PropertyVetoException

getRoles

String getRoles()

Returns:

a String value defines the roles.

setRoles

void setRoles(String value)
       throws PropertyVetoException

Throws:

PropertyVetoException