Package org.codelibs.fess.helper

Class OsddHelper

java.lang.Object

org.codelibs.fess.helper.OsddHelper

public class OsddHelper
extends Object

Helper class for Open Search Description Document.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	contentType	The content type for OSDD response.
protected String	encoding	The encoding for OSDD file.
protected File	osddFile	The OSDD file.
protected String	osddPath	The OSDD file path.

Constructor Summary

Constructors

Constructor	Description
OsddHelper()	Default constructor.

Method Summary

Modifier and Type	Method	Description
org.lastaflute.web.response.StreamResponse	asStream()	Returns the OSDD as a stream response.
protected File	getOsddFile()	Gets the OSDD file.
boolean	hasOpenSearchFile()	Checks if the OpenSearch file exists.
void	init()	Initializes the OSDD helper.
protected boolean	isOsddLinkEnabled()	Checks if OSDD link is enabled.
void	setContentType(String contentType)	Sets the content type.
void	setEncoding(String encoding)	Sets the encoding.
void	setOsddPath(String osddPath)	Sets the OSDD path.

Methods inherited from class java.lang.Object

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

Field Details

osddPath

protected String osddPath

The OSDD file path.

encoding

protected String encoding

The encoding for OSDD file.

contentType

protected String contentType

The content type for OSDD response.

osddFile

protected File osddFile

The OSDD file.

Constructor Details

OsddHelper

public OsddHelper()

Default constructor.

Method Details

init

@PostConstruct
public void init()

Initializes the OSDD helper.

getOsddFile

protected File getOsddFile()

Gets the OSDD file.

Returns:

the OSDD file

isOsddLinkEnabled

protected boolean isOsddLinkEnabled()

Checks if OSDD link is enabled.

Returns:

true if OSDD link is enabled

hasOpenSearchFile

public boolean hasOpenSearchFile()

Checks if the OpenSearch file exists.

Returns:

true if the OpenSearch file exists

asStream

public org.lastaflute.web.response.StreamResponse asStream()

Returns the OSDD as a stream response.

Returns:

the stream response

setOsddPath

public void setOsddPath(String osddPath)

Sets the OSDD path.

Parameters:

osddPath - the OSDD path

setEncoding

public void setEncoding(String encoding)

Sets the encoding.

Parameters:

encoding - the encoding

setContentType

public void setContentType(String contentType)

Sets the content type.

Parameters:

contentType - the content type