Package org.ametys.web.url

Class UrlPreviewComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.url.UrlPreviewComponent

All Implemented Interfaces:

LogEnabled, Component, Contextualizable

public class UrlPreviewComponent
extends AbstractLogEnabled
implements Component, Contextualizable

Component to parse a HTML page to get its meta for preview

Field Summary

Fields

Modifier and Type	Field	Description
private Context	_context
static String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
UrlPreviewComponent()

Method Summary

Modifier and Type	Method	Description
private Connection	_getConnection(String url, String lang)
private String	_getDescription(Document doc)
private String	_getFavicon(Document doc, URL url)
private String	_getImageUrl(Document doc)
private String	_getTitle(Document doc)
private String	_getUserAgent()	Get the user agent from current request
void	contextualize(Context context)
InputStream	convertIcoToPng(InputStream is)	Convert an file.ico into a file.png
String	getFavicon(String url)	Fetch and parse the HTML page at given url to get the favicon url
UrlPreview	getUrlPreview(String url, String lang)	Fetch and parse the HTML page at given url to get the UrlPreview
Map<String,String>	parseUrl(String url, String lang)	Fetch and parse the HTML page at given url for preview

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role

_context

private Context _context

Constructor Detail

UrlPreviewComponent

public UrlPreviewComponent()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getUrlPreview

public UrlPreview getUrlPreview(String url,
                                String lang)
                         throws HttpStatusException,
                                IOException

Fetch and parse the HTML page at given url to get the UrlPreview

Parameters:

url - the url to parse

lang - the language

Returns:

the UrlPreview

Throws:

HttpStatusException - if the HTTP request resulted in a not OK HTTP response.

IOException - if an error occured while parsing HTML page

getFavicon

public String getFavicon(String url)
                  throws IOException

Fetch and parse the HTML page at given url to get the favicon url

Parameters:

url - the url to parse

Returns:

the favicon url or null if not found

Throws:

HttpStatusException - if the HTTP request resulted in a not OK HTTP response.

IOException - if an error occured while parsing HTML page

convertIcoToPng

public InputStream convertIcoToPng(InputStream is)
                            throws IOException

Convert an file.ico into a file.png

Parameters:

is - the input stream of the file.ico

Returns:

the input stream of the file.png

Throws:

IOException - if failed to convert .ico

parseUrl

public Map<String,String> parseUrl(String url,
                                         String lang)

Fetch and parse the HTML page at given url for preview

Parameters:

url - the url to parse

lang - the language

Returns:

the page information for preview

_getConnection

private Connection _getConnection(String url,
                                  String lang)

_getTitle

private String _getTitle(Document doc)

_getDescription

private String _getDescription(Document doc)

_getImageUrl

private String _getImageUrl(Document doc)

_getFavicon

private String _getFavicon(Document doc,
                           URL url)

_getUserAgent

private String _getUserAgent()

Get the user agent from current request

Returns:

the user agent