Package net.webpdf.wsclient.openapi
Class ApplicationConfigConverterWebservice
- java.lang.Object
-
- net.webpdf.wsclient.openapi.ApplicationConfigConverterWebservice
-
public class ApplicationConfigConverterWebservice extends Object
Defines a set of options specific for the \"Converter\" web service.
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_DEFAULT_FONTstatic StringJSON_PROPERTY_ENABLEDstatic StringJSON_PROPERTY_FONT_PATHstatic StringJSON_PROPERTY_INSTANCESstatic StringJSON_PROPERTY_MAX_LATENCYstatic StringJSON_PROPERTY_QUEUE_SIZE
-
Constructor Summary
Constructors Constructor Description ApplicationConfigConverterWebservice()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApplicationConfigConverterWebservicedefaultFont(String defaultFont)ApplicationConfigConverterWebserviceenabled(Boolean enabled)booleanequals(Object o)ApplicationConfigConverterWebservicefontPath(String fontPath)@Nullable StringgetDefaultFont()Sets the default font to be used if the original font was not found and no matching character (for representation) was found in any other font with a similar font family or characteristic.@Nullable BooleangetEnabled()If enabled, then the web service is activated.@Nullable StringgetFontPath()Sets the base path (including subfolders) of the server from which to retrieve installed fonts.@Nullable IntegergetInstances()Number of parallel instances (threads) for the web service.@Nullable IntegergetMaxLatency()Maximum time in seconds allowed for the execution of a web service before the request is aborted.@Nullable IntegergetQueueSize()Maximum number of waiting requests, before new requests are rejected.inthashCode()ApplicationConfigConverterWebserviceinstances(Integer instances)ApplicationConfigConverterWebservicemaxLatency(Integer maxLatency)ApplicationConfigConverterWebservicequeueSize(Integer queueSize)voidsetDefaultFont(String defaultFont)voidsetEnabled(Boolean enabled)voidsetFontPath(String fontPath)voidsetInstances(Integer instances)voidsetMaxLatency(Integer maxLatency)voidsetQueueSize(Integer queueSize)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_DEFAULT_FONT
public static final String JSON_PROPERTY_DEFAULT_FONT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLED
public static final String JSON_PROPERTY_ENABLED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_PATH
public static final String JSON_PROPERTY_FONT_PATH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INSTANCES
public static final String JSON_PROPERTY_INSTANCES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MAX_LATENCY
public static final String JSON_PROPERTY_MAX_LATENCY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_QUEUE_SIZE
public static final String JSON_PROPERTY_QUEUE_SIZE
- See Also:
- Constant Field Values
-
-
Method Detail
-
defaultFont
public ApplicationConfigConverterWebservice defaultFont(String defaultFont)
-
getDefaultFont
@Nullable public @Nullable String getDefaultFont()
Sets the default font to be used if the original font was not found and no matching character (for representation) was found in any other font with a similar font family or characteristic. Therefore, a font should be used that has the widest possible coverage of characters, especially in the Unicode range. **Note:** If no font is specified, then the server tries to find a suitable font (such as \"Arial Unicode MS\" or \"Go Noto Current\"). If these fonts are not available, then the respective default font of the operating system (under Windows \"Arial\" and under Linux \"DejaVu Sans\") is used. If these are not available either, then a corresponding message appears on the server console (or in the logs). **Important:** This setting is supported only by the built-in document converter OutsideIn.- Returns:
- defaultFont
-
setDefaultFont
public void setDefaultFont(String defaultFont)
-
enabled
public ApplicationConfigConverterWebservice enabled(Boolean enabled)
-
getEnabled
@Nullable public @Nullable Boolean getEnabled()
If enabled, then the web service is activated.- Returns:
- enabled
-
setEnabled
public void setEnabled(Boolean enabled)
-
fontPath
public ApplicationConfigConverterWebservice fontPath(String fontPath)
-
getFontPath
@Nullable public @Nullable String getFontPath()
Sets the base path (including subfolders) of the server from which to retrieve installed fonts. If no value is specified, then the default font directories (including subfolders) of the respective operating system are used. Under Windows this is usually `C:\\Windows\\Fonts` and under Linux `/usr/share/fonts/truetype`. **Note:** On Linux, the home directory of the user under which the server is running is also always used in addition. The environment variable `user.home` with the subdirectory `.fonts` is used. **Important:** This setting is supported only by the built-in document converter OutsideIn.- Returns:
- fontPath
-
setFontPath
public void setFontPath(String fontPath)
-
instances
public ApplicationConfigConverterWebservice instances(Integer instances)
-
getInstances
@Nullable public @Nullable Integer getInstances()
Number of parallel instances (threads) for the web service. Defines the number of requests that can be executed in parallel before requests are queued. minimum: 1- Returns:
- instances
-
setInstances
public void setInstances(Integer instances)
-
maxLatency
public ApplicationConfigConverterWebservice maxLatency(Integer maxLatency)
-
getMaxLatency
@Nullable public @Nullable Integer getMaxLatency()
Maximum time in seconds allowed for the execution of a web service before the request is aborted. When time is expired the execution is aborted. minimum: 0- Returns:
- maxLatency
-
setMaxLatency
public void setMaxLatency(Integer maxLatency)
-
queueSize
public ApplicationConfigConverterWebservice queueSize(Integer queueSize)
-
getQueueSize
@Nullable public @Nullable Integer getQueueSize()
Maximum number of waiting requests, before new requests are rejected. If there are more requests than free instances, they are placed in the queue. If this maximum value is reached, further requests are rejected directly.- Returns:
- queueSize
-
setQueueSize
public void setQueueSize(Integer queueSize)
-
-