How to use

PortalPage

in

com.atlassian.jira.portal

public Builder portalPage(PortalPage page)
{
  id = page.getId();
  name = page.getName();
  description = page.getDescription();
  isSystemDashboard = page.isSystemDefaultPortalPage();
  favouriteCount = page.getFavouriteCount();
  permissions = page.getPermissions();
  layout = page.getLayout();
  owner = page.getOwner();
  version = page.getVersion();
  return this;
}

  public boolean evaluate(final Object o)
  {
    final PortalPage portalPage = (PortalPage) o;
    // Has someone apart from the owner favourited this portal page?
    return (favouriteIds.contains(portalPage.getId())) ? portalPage.getFavouriteCount() > 1 : portalPage.getFavouriteCount() > 0;
  }
});

private DashboardTab createDashboardTab(final PortalPage dashboard)
{
  return new DashboardTab(
      DashboardId.valueOf(Long.toString(dashboard.getId())),
      dashboard.getName(),
      URI.create("Dashboard.jspa?selectPageId=" + dashboard.getId()));
}

  public Long get(final PortalPage input)
  {
    return input.getId();
  }
} : null;

public PortalPage update(final PortalPage portalPage)
{
  Assertions.notNull("portalPage", portalPage);
  Assertions.notNull("portalPage.id", portalPage.getId());
  if (!portalPage.isSystemDefaultPortalPage())
  {
    Assertions.notNull("portalPage.owner", portalPage.getOwner());
  }
  final GenericValue gv = findByPrimaryKey(portalPage.getId());
  gv.setString(Column.PAGENAME, portalPage.getName());
  gv.setString(Column.DESCRIPTION, portalPage.getDescription());
  if (!portalPage.isSystemDefaultPortalPage())
  {
    gv.setString(Column.USERNAME, portalPage.getOwner().getKey());
  }
  else
  {
    gv.remove(Column.USERNAME);
  }
  gv.remove(Column.FAVCOUNT);
  gv.setString(Column.LAYOUT, portalPage.getLayout().name());
  delegator.store(gv);
  return getPortalPage(portalPage.getId());
}

public boolean validateForUpdate(final JiraServiceContext serviceCtx, final PortalPage portalPage)
{
  Assertions.notNull("serviceCtx", serviceCtx);
  Assertions.notNull("portalPage", portalPage);
  if (StringUtils.isBlank(portalPage.getName()))
  {
    serviceCtx.getErrorCollection().addError("portalPageName", serviceCtx.getI18nBean().getText("admin.errors.portalpages.must.specify.name"));
  }
  else if (portalPage.isSystemDefaultPortalPage())
  {
    checkSystemDefaultPageForUpdate(serviceCtx, portalPage);
  }
  else
  {
    final boolean ok = checkOwnerShipAndExistenceAndSharePermissions(serviceCtx, portalPage);
    if (ok && (serviceCtx.getLoggedInApplicationUser() != null))
    {
      final PortalPage portalPageByName = portalPageManager.getPortalPageByName(serviceCtx.getLoggedInApplicationUser(), portalPage.getName());
      if ((portalPageByName != null) && !portalPage.getId().equals(portalPageByName.getId()))
      {
        serviceCtx.getErrorCollection().addError("portalPageName", serviceCtx.getI18nBean().getText("admin.errors.portalpages.same.name"));
      }
    }
  }
  if(StringUtils.isNotBlank(portalPage.getDescription()) && portalPage.getDescription().length() > 255)
  {
    serviceCtx.getErrorCollection().addError("portalPageDescription", serviceCtx.getI18nBean().getText("admin.errors.portalpages.description.too.long"));
  }
  return !serviceCtx.getErrorCollection().hasAnyErrors();
}

final Long systemDefaultId = systemDefaultPage.getId();
String desc = systemDefaultPage.getDescription();
if (StringUtils.isBlank(desc))
  desc = i18nHelper.getText("configureportal.clone.page.desc", systemDefaultPage.getName());
PortalPage newPage = PortalPage.name(name).description(desc).owner(user).permissions(SharedEntity.SharePermissions.PRIVATE).build();
  return newPage.getId();

final Long pageId = portalPage.getId();
final String description = portalPage.getDescription();
final String name = portalPage.getName();
String shortName = name;
if (shortName.length() > MAX_LABEL_LENGTH)

@edu.umd.cs.findbugs.annotations.SuppressWarnings(value="UL_UNRELEASED_LOCK_EXCEPTION_PATH", justification="This appears to be doing exactly the right thing with the finally-clause to release the lock")
public PortalPage create(final PortalPage portalPage)
{
  Assertions.notNull("portalPage", portalPage);
  Assertions.notNull("portalPage.name", portalPage.getName());
  Assertions.notNull("portalPage.owner", portalPage.getOwner());
  PortalPage returnPage = null;
  try
  {
    returnPage = delegateStore.create(portalPage);
  }
  finally
  {
    if (returnPage != null)
    {
      cacheByUser.remove(portalPage.getOwner().getKey());
      cacheById.remove(returnPage.getId());
    }
  }
  return copyPortalPage(returnPage);
}

public PortalPage create(final PortalPage portalPage)
{
  Assertions.notNull("portalPage", portalPage);
  Assertions.notNull("portalPage.name", portalPage.getName());
  Assertions.notNull("portalPage.owner", portalPage.getOwner());
  final GenericValue gv = delegator.createValue(Table.NAME, MapBuilder.<String, Object>newBuilder().
      add(Column.PAGENAME, portalPage.getName()).
      add(Column.DESCRIPTION, portalPage.getDescription()).
      add(Column.USERNAME, portalPage.getOwner().getKey()).
      add(Column.FAVCOUNT, 0L).
      add(Column.LAYOUT, portalPage.getLayout().name()).
      add(Column.VERSION, 0L).
      toMap());
  return gvToPortalPage(gv);
}

@Override
public String doDefault()
{
  final PortalPage portalPage = getPortalPage();
  if (portalPage != null)
  {
    if (portalPage.isSystemDefaultPortalPage())
    {
      addErrorMessage(getText("admin.errors.user.cannot.edit.default.dashboard"));
      return ERROR;
    }
    else
    {
      portalPageName = portalPage.getName();
      portalPageDescription = portalPage.getDescription();
      setPermissions(portalPage.getPermissions());
      setFavourite(favouritesService.isFavourite(getLoggedInUser(), portalPage));
    }
  }
  else
  {
    addErrorMessage(getText("admin.errors.user.must.select.page"));
    return ERROR;
  }
  return INPUT;
}

public void validateForChangeOwner(final JiraServiceContext serviceCtx, final PortalPage page)
{
  Assertions.notNull("serviceCtx", serviceCtx);
  Assertions.notNull("page", page);
  if (serviceCtx.getLoggedInApplicationUser() != null)
  {
    final PortalPage portalPageByName = portalPageManager.getPortalPageByName(serviceCtx.getLoggedInApplicationUser(), page.getName());
    if ((portalPageByName != null) && !page.getId().equals(portalPageByName.getId()))
    {
      serviceCtx.getErrorCollection().addErrorMessage( serviceCtx.getI18nBean().getText("admin.errors.portalpages.already.owns.same.name", serviceCtx.getLoggedInApplicationUser().getDisplayName()));
    }
    if (page.getPermissions().isPrivate())
    {
      serviceCtx.getErrorCollection().addErrorMessage(serviceCtx.getI18nBean().getText("admin.errors.portalpages.private"));
    }
  }
}

public PortalPage update(final PortalPage portalPage)
{
  Assertions.notNull("portalPage", portalPage);
  Assertions.notNull("portalPage.id", portalPage.getId());
  final ApplicationUser newOwner = portalPage.getOwner();
  if (!portalPage.isSystemDefaultPortalPage())
  {
    Assertions.notNull("portalPage.owner", newOwner);
  }
  PortalPage returnPage = null;
  PortalPage oldPortalPage = null;
  try
  {
    oldPortalPage = delegateStore.getPortalPage(portalPage.getId());
    returnPage = delegateStore.update(portalPage);
  }
  finally
  {
    cacheById.remove(portalPage.getId());
    if (portalPage.getOwner() != null && (oldPortalPage == null || portalPage.getOwner() != oldPortalPage.getOwner()))
    {
      cacheByUser.remove(portalPage.getOwner().getKey());
    }
    if (oldPortalPage != null && oldPortalPage.getOwner() != portalPage.getOwner())
    {
      cacheByUser.remove(oldPortalPage.getOwner().getKey());
    }
  }
  return returnPage;
}

  private void assertCreate(final PortalPage portalPage)
  {
    notNull("portalPage", portalPage);
    if (!portalPage.isSystemDefaultPortalPage())
    {
      notNull("portalPage.owner", portalPage.getOwner());
    }
    notNull("portalPage.pageName", portalPage.getName());
  }
}

public String getPageName(final PortalPage portalPage)
{
  if (portalPage != null)
  {
    return portalPage.getName();
  }
  else
  {
    return null;
  }
}

@Override
public PortalPage update(final PortalPage portalPage)
{
  assertCreate(portalPage);
  notNull("portalPage.id", portalPage.getId());
  final PortalPage newPortalPage = PortalPage.portalPage(portalPageStore.update(portalPage)).permissions(portalPage.getPermissions()).build();
  shareManager.updateSharePermissions(newPortalPage);
  indexer.index(newPortalPage).await();
  eventPublisher.publish(new DashboardUpdated(portalPage, newPortalPage, authenticationContext.getUser()));
  return newPortalPage;
}

.title(portalPage.getName())
.version(portalPage.getVersion() == null ? 1L : portalPage.getVersion())
.dashboardColumns(dashboardColumns)
.layout(portalPage.getLayout())
.build();

private String createUnfavouriteLink(final PortalPage portalPage)
{
  StringBuilder buffer = new StringBuilder("RemoveFavourite.jspa?entityType=").append(portalPage.getEntityType().getName());
  buffer.append("&entityId=").append(portalPage.getId());
  buffer.append("&atl_token=").append(xsrfTokenGenerator.generateToken());
  buffer.append("&returnUrl=").append("Dashboard.jspa");
  return createLink("dashmsg_unfavourite", buffer.toString());
}

private void updatePortalPage(final PortalPage portalPage, final DashboardState dashboardState)
{
  //update the portalPageStore's title and layout if they changed.
  if (!portalPage.getLayout().equals(dashboardState.getLayout()) ||
      !StringUtils.equals(portalPage.getName(), dashboardState.getTitle()))
  {
    final PortalPage.Builder builder = PortalPage.portalPage(portalPage);
    builder.name(dashboardState.getTitle());
    builder.layout(dashboardState.getLayout());
    portalPageStore.update(builder.build());
  }
}

public boolean validateForCreate(final JiraServiceContext serviceCtx, final PortalPage portalPage)
{
  Assertions.notNull("serviceCtx", serviceCtx);
  Assertions.notNull("portalPage", portalPage);
  checkPermissionsForCreate(serviceCtx, portalPage);
  if (StringUtils.isBlank(portalPage.getName()))
  {
    serviceCtx.getErrorCollection().addError("portalPageName", serviceCtx.getI18nBean().getText("admin.errors.portalpages.must.specify.name"));
  }
  else if (serviceCtx.getLoggedInApplicationUser() != null)
  {
    final PortalPage byName = portalPageManager.getPortalPageByName(serviceCtx.getLoggedInApplicationUser(), portalPage.getName());
    if (byName != null)
    {
      serviceCtx.getErrorCollection().addError("portalPageName", serviceCtx.getI18nBean().getText("admin.errors.portalpages.same.name"));
    }
  }
  if(StringUtils.isNotBlank(portalPage.getDescription()) && portalPage.getDescription().length() > 255)
  {
    serviceCtx.getErrorCollection().addError("portalPageDescription", serviceCtx.getI18nBean().getText("admin.errors.portalpages.description.too.long"));
  }
  return !serviceCtx.getErrorCollection().hasAnyErrors();
}