伺服器端自訂

最後更新： 2024年7月14日

建立對象：

  • 管理員
⇐ Feature Essentials使用者端自訂⇒
SCF Handlebars協助程式⇒

Java™ API

NOTE
從一個主要版本升級至下一個主要版本時，Communities API的套件位置可能會有所變更。

SocialComponent介面

SocialComponents是POJO，代表AEM Communities功能的資源。 理想情況下，每個SocialComponent代表特定的resourceType，其中包含公開的GETters，可提供資料給使用者端，以便準確表示資源。 所有業務和檢視邏輯都會封裝在SocialComponent中，包括網站訪客的工作階段資訊（如有必要）。

介面定義了一組代表資源所需的基本GETter。 重要的是，介面會規定Map<String， Object> getAsMap()和String toJSONString()方法，這些方法對於呈現Handlebars範本及公開資源的GETJSON端點很有必要。

所有SocialComponent類別都必須實作介面com.adobe.cq.social.scf.SocialComponent

SocialCollectionComponent介面

SocialCollectionComponent介面可擴充SocialComponent介面，以便更妥善地表示屬於其他資源集合的資源。

所有SocialCollectionComponent類別都必須實作介面com.adobe.cq.social.scf.SocialCollectionComponent

SocialComponentFactory介面

SocialComponentFactory （工廠）會向架構註冊SocialComponent。 工廠提供一種方法，讓架構知道指定的resourceType有哪些SocialComponents可用，以及識別多個SocialComponents時它們的優先順序排名。

SocialComponentFactory負責建立所選SocialComponent的執行個體，以便使用DI實務從工廠插入SocialComponent所需的所有相依性。

SocialComponentFactory是OSGi服務，可存取其他OSGi服務，這些服務可透過建構函式傳遞給SocialComponent。

所有SocialComponentFactory類別都必須實作介面com.adobe.cq.social.scf.SocialComponentFactory

SocialComponentFactory.getPriority()方法的實作應傳回getResourceType()傳回之指定resourceType所用工廠的最高值。

SocialComponentFactoryManager介面

SocialComponentFactoryManager （管理員）會管理在架構中註冊的所有SocialComponents，並負責選取要用於指定資源(resourceType)的SocialComponentFactory。 如果沒有為特定resourceType登入工廠，則管理員會傳回指定資源具有最接近超級型別的工廠。

SocialComponentFactoryManager是一項OSGi服務，可存取其他OSGi服務，這些服務可透過建構函式傳遞給SocialComponent。

透過叫用com.adobe.cq.social.scf.SocialComponentFactoryManager取得OSGi服務的控制代碼

HTTP API -POST要求

PostOperation類別

HTTP APIPOST端點是由實作SlingPostOperation介面（封裝org.apache.sling.servlets.post）定義的PostOperation類別。

PostOperation端點實作將sling.post.operation設定為作業回應的值。 所有POST請求的：operation引數都設為該值，這些請求都會委派給此實作類別。

PostOperation會叫用SocialOperation，以執行作業所需的動作。

PostOperation從SocialOperation接收結果，並傳回適當的回應給使用者端。

SocialOperation類別

每個SocialOperation端點都會擴充AbstractSocialOperation類別並覆寫方法performOperation()。 此方法會執行完成作業所需的所有動作，並傳回SocialOperationResult或擲回OperationException。 在這種情況下，會傳回包含訊息的HTTP錯誤狀態（如果可用），以取代一般JSON回應或成功HTTP狀態代碼。

延伸AbstractSocialOperation可重複使用SocialComponents來傳送JSON回應。

SocialOperationResult類別

SocialOperationResult類別是以SocialOperation的結果傳回，並由SocialComponent、HTTP狀態碼和HTTP狀態訊息組成。

SocialComponent代表受作業影響的資源。

對於Create作業，SocialOperationResult中包含的SocialComponent代表已建立的資源，而對於Update作業，它代表作業變更的資源。 刪除作業未傳回任何SocialComponent。

使用的成功HTTP狀態代碼為：

  • 201用於建立操作
  • 200表示更新作業
  • 204 （刪除作業）