Skip to content

Commit f77d190

Browse files
committed
Fix javadocs
Signed-off-by: Daniel Widdis <[email protected]>
1 parent b6d976f commit f77d190

File tree

4 files changed

+14
-0
lines changed

4 files changed

+14
-0
lines changed

src/main/java/org/opensearch/flowframework/FlowFrameworkResourceSharingExtension.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
import static org.opensearch.flowframework.common.CommonValue.GLOBAL_CONTEXT_INDEX;
2020
import static org.opensearch.flowframework.common.CommonValue.WORKFLOW_STATE_INDEX;
2121

22+
/**
23+
* Implementation for sharing resources that require access control.
24+
*/
2225
public class FlowFrameworkResourceSharingExtension implements ResourceSharingExtension {
2326
@Override
2427
public Set<ResourceProvider> getResourceProviders() {

src/main/java/org/opensearch/flowframework/transport/handler/SearchHandler.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public void search(SearchRequest request, String tenantId, String resourceType,
9090
* @param request SearchRequest
9191
* @param tenantId the tenant id
9292
* @param user User
93+
* @param resoureType the resource type
9394
* @param listener ActionListener
9495
* @param context ThreadContext
9596
*/

src/main/java/org/opensearch/flowframework/util/PluginClient.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ public class PluginClient extends FilterClient {
2828

2929
private Subject subject;
3030

31+
/**
32+
* Constructor for PluginClient
33+
* @param client the underlying client to wrap
34+
*/
3135
public PluginClient(Client client) {
3236
super(client);
3337
}

src/main/java/org/opensearch/flowframework/util/ResourceSharingClientAccessor.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ public class ResourceSharingClientAccessor {
2222

2323
private ResourceSharingClientAccessor() {}
2424

25+
/**
26+
* Get the singleton instance of ResourceSharingClientAccessor
27+
* @return the singleton instance
28+
*/
2529
public static ResourceSharingClientAccessor getInstance() {
2630
if (resourceSharingClientAccessor == null) {
2731
resourceSharingClientAccessor = new ResourceSharingClientAccessor();
@@ -32,13 +36,15 @@ public static ResourceSharingClientAccessor getInstance() {
3236

3337
/**
3438
* Set the resource sharing client
39+
* @param client the resource sharing client to set
3540
*/
3641
public void setResourceSharingClient(ResourceSharingClient client) {
3742
resourceSharingClientAccessor.client.set(client);
3843
}
3944

4045
/**
4146
* Get the resource sharing client
47+
* @return the resource sharing client
4248
*/
4349
public ResourceSharingClient getResourceSharingClient() {
4450
return resourceSharingClientAccessor.client.get();

0 commit comments

Comments
 (0)