com.ibm.commerce.content.commands

Interface ResolveContentURLCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    ResolveContentURLCmdImpl


    public interface ResolveContentURLCmd
    extends TaskCommand
    This task command is used by the wcst:resolveContentURL tag to resolve content URLs.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        Copyright statement.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full class name for this interface file.
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class name. This is used if there is no record found in the CMDREG table.
    • Method Detail

      • setUnresolvedURL

        void setUnresolvedURL(java.lang.String unresolvedUrl)
        Set the unresolved content URL.
        Parameters:
        unresolvedUrl - unresolved content URL
      • setStoreStaticAssets

        void setStoreStaticAssets(boolean storeStaticAssets)
        Indicates that the content URL is to be resolved for grabbing store static assets from Content Management System. Set to false if this is not for static assets from CMS
        Parameters:
        storeStaticAssets - store static asset option
      • setUseCustomerTenantWCH

        void setUseCustomerTenantWCH(boolean useCustomerTenantWCH)
        Indicates that the content URL is to be resolved will point to customer tenant in WCH instead of default IBM tenant.
      • setInternal

        void setInternal(boolean internal)
        Indicates that the content URL is to be resolved for an internal call from the application server. Set to false if the URL is intended to be used externally by the browser.
        Parameters:
        internal - internal URL option
      • setPreview

        void setPreview(boolean preview)
        Indicates that the content URL is to be resolved to the preview location of the content. Set to false for production URLs.
        Parameters:
        preview - preview option
      • setIncludeHostName

        void setIncludeHostName(boolean includeHostName)
        Indicates that the content URL must be a fully qualified URL that includes the scheme, host name and port. Set this property to true to force the URLs to be fully qualified with the content host name. For example, if the URL is intended for inclusion in an e-mail, then if must be fully qualified.
        Parameters:
        includeHostName - includeHostName option
      • getResolvedURL

        java.lang.String getResolvedURL()
        Return the resolved content URL.
        Returns:
        the resolved content URL
      • getResolvedMimeType

        java.lang.String getResolvedMimeType()
        Return the resolved MIME content type.
        Returns:
        the resolved MIME content type
      • getResolvedMimeSubtype

        java.lang.String getResolvedMimeSubtype()
        Return the resolved MIME content sub-type.
        Returns:
        the resolved MIME content sub-type
      • getResolvedRenderType

        java.lang.String getResolvedRenderType()
        Get the resolved render type. This value is available after the command is executed. The value can be CONTENT, LINK or RESOURCE. A value of CONTENT indicates that the content is an HTML fragment that is to be embedded in an HTML page. A value of LINK indicates that the content is a stand alone HTML page and that the content URL is to be rendered as a link to that page using the HTML anchor (A) tag. A value of RESOURCE indicates that the content is an image or other type of file and that the content URL is to be rendered according to the MIME type.
        Returns:
        the resolved render type