ResourceLink.java

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2015 wcm.io
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.handler.link.ui;

import java.util.Map;

import javax.annotation.PostConstruct;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import io.wcm.handler.link.Link;
import io.wcm.handler.link.LinkHandler;

/**
 * Generic resource-based link model.
 */
@Model(adaptables = SlingHttpServletRequest.class)
public class ResourceLink {

  @Self
  private LinkHandler linkHandler;
  @SlingObject
  private Resource resource;

  private Link link;

  @PostConstruct
  private void activate() {
    link = linkHandler.get(resource).build();
  }

  /**
   * Returns a {@link Link} object with the metadata of the resolved link.
   * Result is never null, check for validness with the {@link Link#isValid()} method.
   * @return Link
   */
  public @NotNull Link getMetadata() {
    return link;
  }

  /**
   * Returns true if the link was resolved successful.
   * @return Link is valid
   */
  public boolean isValid() {
    return link.isValid();
  }

  /**
   * Returns a map of attributes which can be applied to a HTML anchor element.
   * @return Anchor attributes
   */
  public @Nullable Map<String, String> getAttributes() {
    return link.getAnchorAttributes();
  }

}