Package de.swa.gmaf.api

Interface GMAF_Facade

All Known Implementing Classes:
GMAF_Facade_SOAPImpl
public interface GMAF_Facade
GMAF API - SOAP implementation facade

  • Method Summary

    Modifier and Type Method Description
    GraphCode generateGraphCode​(java.lang.String auth_token, MMFG mmfg)
    returns a Graph Code for a given MMFG
    java.lang.String getAuthToken​(java.lang.String api_key)
    returns a new session token
    java.util.Vector<java.lang.String> getCollectionIDs​(java.lang.String auth_token)
    returns the collection of MMFGs for a given auth_token
    MMFG getMMFG​(java.lang.String auth_token, java.lang.String id)
    returns a list of recommendations for a given Graph Code
    GraphCode getOrGenerateGraphCode​(java.lang.String auth_token, java.lang.String mmfg)
    returns a Graph Code for a given MMFG-ID
    java.lang.String getPreviewURL​(java.lang.String auth_token, java.lang.String mmfg_id)
    returns an URL to preview a MMFG
    java.util.Vector<java.lang.String> getRecommendedAssetIDsByGraphCode​(java.lang.String auth_token, GraphCode gc)
    returns a list of recommendations for a given Graph Code
    java.util.Vector<java.lang.String> getRecommendedAssetIDsForMMFGId​(java.lang.String auth_token, java.lang.String id)
    returns a list of recommendations for a given Graph Code
    java.util.Vector<java.lang.String> getSimilarAssetIDsByGraphCode​(java.lang.String auth_token, GraphCode gc)
    returns a list of similar assets for a given Graph Code
    java.util.Vector<java.lang.String> getSimilarAssetIDsForMMFGId​(java.lang.String auth_token, java.lang.String id)
    returns a list of similar assets for a given Graph Code
    java.lang.String processAssetFromBytes​(java.lang.String auth_token, byte[] bytes, java.lang.String suffix)
    processes an asset with the GMAF Core and returns the calculated MMFG
    java.lang.String processAssetFromFile​(java.lang.String auth_token, java.io.File f)
    processes an asset with the GMAF Core and returns the calculated MMFG
    java.lang.String processAssetFromURL​(java.lang.String auth_token, java.net.URL url)
    processes an asset with the GMAF Core and returns the calculated MMFG
    java.util.Vector<java.lang.String> queryByKeyword​(java.lang.String auth_token, java.lang.String keywords)
    returns a list of similar assets for a given keyword
    void setProcessingPlugins​(java.lang.String auth_token, java.util.Vector<java.lang.String> plugins)
    sets the classes of the processing plugins (optional)

  • Method Details

    • getAuthToken

      java.lang.String getAuthToken​(java.lang.String api_key)
      returns a new session token

    • processAssetFromFile

      java.lang.String processAssetFromFile​(java.lang.String auth_token, java.io.File f)
      processes an asset with the GMAF Core and returns the calculated MMFG

    • processAssetFromBytes

      java.lang.String processAssetFromBytes​(java.lang.String auth_token, byte[] bytes, java.lang.String suffix)
      processes an asset with the GMAF Core and returns the calculated MMFG

    • processAssetFromURL

      java.lang.String processAssetFromURL​(java.lang.String auth_token, java.net.URL url)
      processes an asset with the GMAF Core and returns the calculated MMFG

    • setProcessingPlugins

      void setProcessingPlugins​(java.lang.String auth_token, java.util.Vector<java.lang.String> plugins)
      sets the classes of the processing plugins (optional)

    • getCollectionIDs

      java.util.Vector<java.lang.String> getCollectionIDs​(java.lang.String auth_token)
      returns the collection of MMFGs for a given auth_token

    • generateGraphCode

      GraphCode generateGraphCode​(java.lang.String auth_token, MMFG mmfg)
      returns a Graph Code for a given MMFG

    • getOrGenerateGraphCode

      GraphCode getOrGenerateGraphCode​(java.lang.String auth_token, java.lang.String mmfg)
      returns a Graph Code for a given MMFG-ID

    • getSimilarAssetIDsByGraphCode

      java.util.Vector<java.lang.String> getSimilarAssetIDsByGraphCode​(java.lang.String auth_token, GraphCode gc)
      returns a list of similar assets for a given Graph Code

    • getRecommendedAssetIDsByGraphCode

      java.util.Vector<java.lang.String> getRecommendedAssetIDsByGraphCode​(java.lang.String auth_token, GraphCode gc)
      returns a list of recommendations for a given Graph Code

    • getSimilarAssetIDsForMMFGId

      java.util.Vector<java.lang.String> getSimilarAssetIDsForMMFGId​(java.lang.String auth_token, java.lang.String id)
      returns a list of similar assets for a given Graph Code

    • getRecommendedAssetIDsForMMFGId

      java.util.Vector<java.lang.String> getRecommendedAssetIDsForMMFGId​(java.lang.String auth_token, java.lang.String id)
      returns a list of recommendations for a given Graph Code

    • getMMFG

      MMFG getMMFG​(java.lang.String auth_token, java.lang.String id)
      returns a list of recommendations for a given Graph Code

    • getPreviewURL

      java.lang.String getPreviewURL​(java.lang.String auth_token, java.lang.String mmfg_id)
      returns an URL to preview a MMFG

    • queryByKeyword

      java.util.Vector<java.lang.String> queryByKeyword​(java.lang.String auth_token, java.lang.String keywords)
      returns a list of similar assets for a given keyword