How to use

org.apache.wicket.request.target.component.BookmarkablePageRequestTarget

constructor

/**
 * Sets the page class with optionally the page parameters and page map name as the render
 * target of this request.
 * 
 * @param pageClass
 *            The page class to render as a response
 * @param pageParameters
 *            The page parameters that gets appended to the bookmarkable url,
 * @param pageMapName
 *            The pagemap in which the response page should be created
 */
public final void setResponsePage(final Class pageClass, final PageParameters pageParameters,
  final String pageMapName)
{
  IRequestTarget target = new BookmarkablePageRequestTarget(pageMapName, pageClass,
    pageParameters);
  setRequestTarget(target);
}

/**
 * Sets the page class with optionally the page parameters and page map name as the render
 * target of this request.
 * 
 * @param <C>
 * 
 * @param pageClass
 *            The page class to render as a response
 * @param pageParameters
 *            The page parameters that gets appended to the bookmarkable url,
 * @param pageMapName
 *            The Pagemap in which the response page should be created
 */
public final <C extends Page> void setResponsePage(final Class<C> pageClass,
  final PageParameters pageParameters, final String pageMapName)
{
  IRequestTarget target = new BookmarkablePageRequestTarget(pageMapName, pageClass,
    pageParameters);
  setRequestTarget(target);
}

/**
 * Returns a bookmarkable URL that references a given page class using a given set of page
 * parameters. Since the URL which is returned contains all information necessary to instantiate
 * and render the page, it can be stored in a user's browser as a stable bookmark.
 * 
 * @param pageMap
 *            Pagemap to use. If null is passed the default page map will be used
 * @param pageClass
 *            Class of page
 * @param parameters
 *            Parameters to page
 * @return Bookmarkable URL to page
 */
public final CharSequence urlFor(final IPageMap pageMap, final Class pageClass,
  final PageParameters parameters)
{
  final IRequestTarget target = new BookmarkablePageRequestTarget(pageMap == null
    ? PageMap.DEFAULT_NAME : pageMap.getName(), pageClass, parameters);
  return encodeUrlFor(target);
}

/**
 * Returns a bookmarkable URL that references a given page class using a given set of page
 * parameters. Since the URL which is returned contains all information necessary to instantiate
 * and render the page, it can be stored in a user's browser as a stable bookmark.
 * 
 * @param <C>
 * 
 * @param pageMap
 *            Pagemap to use. If null is passed the default page map will be used
 * @param pageClass
 *            Class of page
 * @param parameters
 *            Parameters to page
 * @return Bookmarkable URL to page
 */
public final <C extends Page> CharSequence urlFor(final IPageMap pageMap,
  final Class<C> pageClass, final PageParameters parameters)
{
  final IRequestTarget target = new BookmarkablePageRequestTarget(pageMap == null
    ? PageMap.DEFAULT_NAME : pageMap.getName(), pageClass, parameters);
  return encodeUrlFor(target);
}

/**
 * Checks whether the given <code>pageClass</code> is mounted.
 * 
 * @param pageClass
 *            the <code>Class</code> of the <code>Page</code> to be checked
 * @return true if the given <code>pageClass</code> is mounted, false otherwise
 */
private boolean isPageMounted(Class<? extends Page> pageClass)
{
  RequestCycle.get();
  CharSequence path = getRequestCodingStrategy().pathForTarget(
    new BookmarkablePageRequestTarget(pageClass));
  return path != null;
}

/**
 * Checks whether the given <code>pageClass</code> is mounted.
 * 
 * @param pageClass
 *            the <code>Class</code> of the <code>Page</code> to be checked
 * @return true if the given <code>pageClass</code> is mounted, false otherwise
 */
private boolean isPageMounted(Class /* <? extends Page> */pageClass)
{
  RequestCycle cycle = RequestCycle.get();
  CharSequence path = getRequestCodingStrategy().pathForTarget(
    new BookmarkablePageRequestTarget(pageClass));
  return path != null;
}

@Override
public IRequestTarget decode(RequestParameters requestParameters)
{
  String pageMapName = requestParameters.getPageMapName();
  final PageParameters parameters = new PageParameters(requestParameters.getParameters());
  // This might be a request to a stateless page, so check for an
  // interface name.
  if (requestParameters.getInterfaceName() != null)
  {
    return new BookmarkableListenerInterfaceRequestTarget(pageMapName,
      bookmarkablePageClassRef.get(), parameters, requestParameters.getComponentPath(),
      requestParameters.getInterfaceName(), requestParameters.getVersionNumber());
  }
  else
  {
    return new BookmarkablePageRequestTarget(pageMapName,
      (Class)bookmarkablePageClassRef.get(), parameters);
  }
}

public IRequestTarget decode(RequestParameters requestParameters)
{
  String pageMapName = requestParameters.getPageMapName();
  final PageParameters parameters = new PageParameters(requestParameters.getParameters());
  // This might be a request to a stateless page, so check for an
  // interface name.
  if (requestParameters.getInterfaceName() != null)
  {
    return new BookmarkableListenerInterfaceRequestTarget(pageMapName,
        (Class)bookmarkablePageClassRef.get(), parameters, requestParameters
            .getComponentPath(), requestParameters.getInterfaceName(),
        requestParameters.getVersionNumber());
  }
  else
  {
    return new BookmarkablePageRequestTarget(pageMapName, (Class)bookmarkablePageClassRef
        .get(), parameters);
  }
}

/**
 * Adds components.
 */
private final void initComps()
{
  WebComponent meta = new WebComponent("meta");
  PageParameters parameters = new PageParameters();
  parameters.put("cto", continueTo);
  CharSequence url = urlFor(new BookmarkablePageRequestTarget(BrowserInfoPage.class,
      parameters));
  meta.add(new AttributeModifier("content", true, new Model("0; url=" + url)));
  add(meta);
  WebMarkupContainer link = new WebMarkupContainer("link");
  link.add(new AttributeModifier("href", true, new Model((Serializable)url)));
  add(link);
  add(new BrowserInfoForm("postback")
  {
    private static final long serialVersionUID = 1L;
    /**
     * @see org.apache.wicket.markup.html.pages.BrowserInfoForm#afterSubmit()
     */
    protected void afterSubmit()
    {
      continueToPrevious();
    }
  });
}

/**
 * Adds components.
 */
private final void initComps()
{
  WebComponent meta = new WebComponent("meta");
  PageParameters parameters = new PageParameters();
  parameters.put("cto", continueTo);
  CharSequence url = urlFor(new BookmarkablePageRequestTarget(BrowserInfoPage.class,
    parameters));
  meta.add(new AttributeModifier("content", true, new Model<String>("0; url=" + url)));
  add(meta);
  WebMarkupContainer link = new WebMarkupContainer("link");
  link.add(new AttributeModifier("href", true, new Model<Serializable>((Serializable)url)));
  add(link);
  add(new BrowserInfoForm("postback")
  {
    private static final long serialVersionUID = 1L;
    /**
     * @see org.apache.wicket.markup.html.pages.BrowserInfoForm#afterSubmit()
     */
    @Override
    protected void afterSubmit()
    {
      continueToPrevious();
    }
  });
}

return new BookmarkablePageRequestTarget(pageMapName, bookmarkablePageClass, parameters);

/**
 * Initialize a new WebRequestCycle and all its dependent objects
 * 
 * @param pageClass
 * @param params
 */
public void processRequestCycle(final Class pageClass, PageParameters params)
{
  setupRequestAndResponse();
  final WebRequestCycle cycle = createRequestCycle();
  try
  {
    BaseWicketTester.callOnBeginRequest(cycle);
    cycle.request(new BookmarkablePageRequestTarget(pageClass, params));
  }
  finally
  {
    cycle.getResponse().close();
  }
  postProcessRequestCycle(cycle);
}

  /**
   * <p>buildFromTransition.</p>
   *
   * @param eventId a {@link java.lang.String} object.
   * @param requestCycle a {@link org.apache.wicket.RequestCycle} object.
   * @return a {@link org.apache.wicket.request.target.component.BookmarkablePageRequestTarget} object.
   */
  public static BookmarkablePageRequestTarget buildFromTransition(String eventId,RequestCycle requestCycle){
    FlowState<?> flowState = PageFlowSession.get().getFlowState();
    
    Class<? extends WebPage> nextPage = FlowUtils.getNextPage(eventId);
    
    PageParameters pars = requestCycle.getPageParameters();
    if(pars == null){
      pars = new PageParameters();
    }
    pars.put("flowExecutionKey", flowState.getCurrentViewState());
    
    //TODO Need to determine the last displayed page class when the current view state is DONE and the input
    //flow execution is not valid
    
    //Create a target for the last rendered page
    BookmarkablePageRequestTarget target = new BookmarkablePageRequestTarget((Class<? extends WebPage>)
        nextPage, pars);
    
    return target;
  }
}

return new BookmarkablePageRequestTarget(pageMapName, (Class)bookmarkablePageClassRef
    .get(), parameters);

return urlFor(new BookmarkablePageRequestTarget(pageMapName, getPageClass(), parameters));

return new BookmarkablePageRequestTarget(requestParameters.getPageMapName(),
  (Class<? extends Page>)bookmarkablePageClassRef.get(), parameters);

BookmarkablePageRequestTarget homepageTarget = new BookmarkablePageRequestTarget(
  homePageClass, parameters);
IRequestCodingStrategy requestCodingStrategy = requestCycle.getProcessor()

BookmarkablePageRequestTarget homepageTarget = new BookmarkablePageRequestTarget(
  homePageClass, parameters);
IRequestCodingStrategy requestCodingStrategy = requestCycle.getProcessor()

return new BookmarkablePageRequestTarget(requestParameters.getPageMapName(),
  pageClass, params);

return new BookmarkablePageRequestTarget(requestParameters.getPageMapName(),
  pageClass, params);