com.xpn.xwiki.web
Interface XWikiURLFactory

All Known Implementing Classes:
ExportURLFactory, ExternalServletURLFactory, PdfURLFactory, XWikiDebugGWTURLFactory, XWikiDefaultURLFactory, XWikiServletURLFactory, XWikiXmlRpcURLFactory

public interface XWikiURLFactory


Method Summary
 URL createAttachmentRevisionURL(String filename, String web, String name, String revision, String querystring, String xwikidb, XWikiContext context)
           
 URL createAttachmentRevisionURL(String filename, String web, String name, String revision, String querystring, XWikiContext context)
           
 URL createAttachmentURL(String filename, String web, String name, String action, String querystring, String xwikidb, XWikiContext context)
           
 URL createAttachmentURL(String filename, String web, String name, String action, String querystring, XWikiContext context)
           
 URL createExternalURL(String web, String name, String action, String querystring, String anchor, String xwikidb, XWikiContext context)
           
 URL createExternalURL(String web, String name, String action, String querystring, String anchor, XWikiContext context)
           
 URL createResourceURL(String filename, boolean forceSkinAction, XWikiContext context)
           
 URL createSkinURL(String filename, String web, String name, String xwikidb, XWikiContext context)
           
 URL createSkinURL(String filename, String web, String name, XWikiContext context)
           
 URL createSkinURL(String filename, String skin, XWikiContext context)
           
 URL createURL(String web, String name, String action, boolean redirect, XWikiContext context)
           
 URL createURL(String web, String name, String action, String querystring, String anchor, String xwikidb, XWikiContext context)
           
 URL createURL(String web, String name, String action, String querystring, String anchor, XWikiContext context)
           
 URL createURL(String web, String name, String action, XWikiContext context)
           
 URL createURL(String web, String name, XWikiContext context)
           
 URL getRequestURL(XWikiContext context)
           
 URL getServerURL(XWikiContext context)
          Generate the base external URL to access this server.
 String getURL(URL url, XWikiContext context)
          Converts a URL to a string representation.
 void init(XWikiContext context)
           
 

Method Detail

init

void init(XWikiContext context)

createURL

URL createURL(String web,
              String name,
              XWikiContext context)

createURL

URL createURL(String web,
              String name,
              String action,
              XWikiContext context)

createURL

URL createURL(String web,
              String name,
              String action,
              boolean redirect,
              XWikiContext context)

createURL

URL createURL(String web,
              String name,
              String action,
              String querystring,
              String anchor,
              XWikiContext context)

createExternalURL

URL createExternalURL(String web,
                      String name,
                      String action,
                      String querystring,
                      String anchor,
                      XWikiContext context)

createURL

URL createURL(String web,
              String name,
              String action,
              String querystring,
              String anchor,
              String xwikidb,
              XWikiContext context)

createExternalURL

URL createExternalURL(String web,
                      String name,
                      String action,
                      String querystring,
                      String anchor,
                      String xwikidb,
                      XWikiContext context)

createSkinURL

URL createSkinURL(String filename,
                  String skin,
                  XWikiContext context)

createSkinURL

URL createSkinURL(String filename,
                  String web,
                  String name,
                  XWikiContext context)

createSkinURL

URL createSkinURL(String filename,
                  String web,
                  String name,
                  String xwikidb,
                  XWikiContext context)

createResourceURL

URL createResourceURL(String filename,
                      boolean forceSkinAction,
                      XWikiContext context)

createAttachmentURL

URL createAttachmentURL(String filename,
                        String web,
                        String name,
                        String action,
                        String querystring,
                        XWikiContext context)

createAttachmentURL

URL createAttachmentURL(String filename,
                        String web,
                        String name,
                        String action,
                        String querystring,
                        String xwikidb,
                        XWikiContext context)

createAttachmentRevisionURL

URL createAttachmentRevisionURL(String filename,
                                String web,
                                String name,
                                String revision,
                                String querystring,
                                XWikiContext context)

createAttachmentRevisionURL

URL createAttachmentRevisionURL(String filename,
                                String web,
                                String name,
                                String revision,
                                String querystring,
                                String xwikidb,
                                XWikiContext context)

getRequestURL

URL getRequestURL(XWikiContext context)

getURL

String getURL(URL url,
              XWikiContext context)
Converts a URL to a string representation. It's up to the implementation to decide whether to perform transformations or not on the URL. For example some implementations will convert the URL to a relative URL if the URL is an internal XWiki URL.

Parameters:
url - the URL to convert
Returns:
the converted URL as a string

getServerURL

URL getServerURL(XWikiContext context)
                 throws MalformedURLException
Generate the base external URL to access this server.

Parameters:
context - the XWiki context.
Returns:
the URL of the server.
Throws:
MalformedURLException - error when creating the URL.


Copyright © 2004-2013 XWiki. All Rights Reserved.