Package io.jmix.rest

Class RestProperties

java.lang.Object

io.jmix.rest.RestProperties

@ConfigurationProperties(prefix="jmix.rest")
public class RestProperties
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	inlineEnabledFileExtensions	File extensions that can be opened for viewing in a browser by replying with 'Content-Disposition=inline' header.

Constructor Summary

Constructors

Constructor

Description

RestProperties(String basePath, String entitiesPath, String docsPath, String metadataPath, String filesPath, String messagesPath, String permissionsPath, String queriesPath, String servicesPath, String userInfoPath, String userSessionPath, String capabilitiesPath, boolean optimisticLockingEnabled, boolean responseFetchPlanEnabled, int defaultMaxFetchSize, Set<String> inlineEnabledFileExtensions, Map<String,Integer> entityMaxFetchSize, boolean inlineFetchPlanEnabled, String servicesConfig, String queriesConfig)

Method Summary

Modifier and Type	Method	Description
String	getBasePath()
String	getCapabilitiesPath()
String	getDocsPath()
String	getEntitiesPath()
int	getEntityMaxFetchSize(String entityName)
String	getFilesPath()
Set<String>	getInlineEnabledFileExtensions()
String	getMessagesPath()
String	getMetadataPath()
String	getPermissionsPath()
String	getQueriesConfig()
String	getQueriesPath()
String	getServicesConfig()
String	getServicesPath()
String	getUserInfoPath()
String	getUserSessionPath()
boolean	isInlineFetchPlanEnabled()
boolean	isOptimisticLockingEnabled()
boolean	isResponseFetchPlanEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

inlineEnabledFileExtensions

protected Set<String> inlineEnabledFileExtensions

File extensions that can be opened for viewing in a browser by replying with 'Content-Disposition=inline' header.

Constructor Details

RestProperties

public RestProperties(@DefaultValue("/rest")
 String basePath,
 @DefaultValue("/entities")
 String entitiesPath,
 @DefaultValue("/docs")
 String docsPath,
 @DefaultValue("/metadata")
 String metadataPath,
 @DefaultValue("/files")
 String filesPath,
 @DefaultValue("/messages")
 String messagesPath,
 @DefaultValue("/permissions")
 String permissionsPath,
 @DefaultValue("/queries")
 String queriesPath,
 @DefaultValue("/services")
 String servicesPath,
 @DefaultValue("/userInfo")
 String userInfoPath,
 @DefaultValue("/user-session")
 String userSessionPath,
 @DefaultValue("/capabilities")
 String capabilitiesPath,
 @DefaultValue("false")
 boolean optimisticLockingEnabled,
 @DefaultValue("true")
 boolean responseFetchPlanEnabled,
 @DefaultValue("10000")
 int defaultMaxFetchSize,
 @DefaultValue({"jpg","png","jpeg","pdf"})
 Set<String> inlineEnabledFileExtensions,
 @Nullable
 Map<String,Integer> entityMaxFetchSize,
 @DefaultValue("true")
 boolean inlineFetchPlanEnabled,
 String servicesConfig,
 String queriesConfig)

Method Details

getBasePath

public String getBasePath()

See Also:

• basePath

getEntitiesPath

public String getEntitiesPath()

See Also:

• entitiesPath

getDocsPath

public String getDocsPath()

See Also:

• docsPath

getMetadataPath

public String getMetadataPath()

See Also:

• metadataPath

getFilesPath

public String getFilesPath()

See Also:

• filesPath

getMessagesPath

public String getMessagesPath()

See Also:

• messagesPath

getPermissionsPath

public String getPermissionsPath()

See Also:

• permissionsPath

getQueriesPath

public String getQueriesPath()

See Also:

• queriesPath

getServicesPath

public String getServicesPath()

See Also:

• servicesPath

getUserInfoPath

public String getUserInfoPath()

See Also:

• userInfoPath

getUserSessionPath

public String getUserSessionPath()

See Also:

• userSessionPath

getCapabilitiesPath

public String getCapabilitiesPath()

See Also:

• capabilitiesPath

isOptimisticLockingEnabled

public boolean isOptimisticLockingEnabled()

See Also:

• optimisticLockingEnabled

isResponseFetchPlanEnabled

public boolean isResponseFetchPlanEnabled()

See Also:

• responseFetchPlanEnabled

getInlineEnabledFileExtensions

public Set<String> getInlineEnabledFileExtensions()

See Also:

• inlineEnabledFileExtensions

getEntityMaxFetchSize

public int getEntityMaxFetchSize(String entityName)

isInlineFetchPlanEnabled

public boolean isInlineFetchPlanEnabled()

See Also:

• inlineFetchPlanEnabled

getServicesConfig

public String getServicesConfig()

See Also:

• servicesPath

getQueriesConfig

public String getQueriesConfig()

See Also:

• queriesPath