org.gluu.oxtrust.api.client.group.GroupClient クラス

org.gluu.oxtrust.api.client.group.GroupClient の継承関係図

org.gluu.oxtrust.api.client.group.GroupClient 連携図

公開メンバ関数
	GroupClient (Client client, String baseURI)
List< GluuGroup >	list ()
List< GluuGroup >	searchGroups (String pattern, int size)
GluuGroup	getGroup (String inum)
T	read (String id) throws ClientErrorException
String	create (T requestEntity) throws OxTrustAPIException
String	add (T requestEntity) throws OxTrustAPIException
boolean	update (T requestEntity, String id)
boolean	delete (String id)
boolean	remove (String inum)

静的公開変数類
static final int	HTTP_OK = 200

限定公開変数類
WebTarget	webTarget
Client	client
Class< T >	entityClass

静的非公開変数類
static final Logger	logger = LogManager.getLogger(GroupClient.class)
static final String	PATH = "/restv1/api/groups"

詳解

構築子と解体子

GroupClient()

org.gluu.oxtrust.api.client.group.GroupClient.GroupClient ( Client  client, String  baseURI  )

inline

                                                          {
                super(GluuGroup.class, client, baseURI, PATH);
        }

関数詳解

add()

String org.gluu.oxtrust.api.client.util.AbstractClient< T >.add ( T  requestEntity ) throws OxTrustAPIException

inlineinherited

                                                                      {
                WebTarget resource=webTarget;
                System.out.println("Final Url:" + resource.getUri().toString());
                Response response = resource.request().post(Entity.entity(requestEntity, MediaType.APPLICATION_JSON));
                if (response.getStatus() != HTTP_OK) {
                        System.out.println("Error:" + response.getStatus());
                        throw new OxTrustAPIException("Response error. HTTP code: " + response.getStatus() + ", reason phrase: "
                                        + response.getStatusInfo().getReasonPhrase(), response.getStatus());
                }
                response.close();
                return response.readEntity(String.class);
        }

create()

String org.gluu.oxtrust.api.client.util.AbstractClient< T >.create ( T  requestEntity ) throws OxTrustAPIException

inlineinherited

Create (save) entity.

引数

requestEntity

戻り値

ID of created entity (inum bu default)

例外

ClientErrorException
OxTrustAPIException

                                                                         {
                Response response = webTarget.path("create").request()
                                .post(Entity.entity(requestEntity, MediaType.APPLICATION_JSON));
                if (response.getStatus() != HTTP_OK) {
                        throw new OxTrustAPIException("Response error. HTTP code: " + response.getStatus() + ", reason phrase: "
                                        + response.getStatusInfo().getReasonPhrase(), response.getStatus());
                }
                String id = response.readEntity(String.class);
                response.close();

                return id;
        }

delete()

boolean org.gluu.oxtrust.api.client.util.AbstractClient< T >.delete ( String  id )

inlineinherited

                                         {
                WebTarget resource = webTarget.path("delete/{id}").resolveTemplate("id", id);
                Response response = resource.request(MediaType.TEXT_PLAIN).delete();

                int code = response.getStatus();
                response.close();
                return code == HTTP_OK;
        }

getGroup()

GluuGroup org.gluu.oxtrust.api.client.group.GroupClient.getGroup ( String  inum )

inline

                                               {
                logger.debug("Final Url:" + webTarget.getUri().toString());
                WebTarget resource = webTarget.path("/{inum}").resolveTemplate("inum", inum);
                return resource.request(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).get(GluuGroup.class);
        }

list()

List<GluuGroup> org.gluu.oxtrust.api.client.group.GroupClient.list ( )

inline

                                      {
                logger.debug("Final Url:" + webTarget.getUri().toString());
                GenericType<List<GluuGroup>> responseType = new GenericType<List<GluuGroup>>() {
                };
                return webTarget.request().get(responseType);
        }

read()

T org.gluu.oxtrust.api.client.util.AbstractClient< T >.read ( String  id ) throws ClientErrorException

inlineinherited

Read entity by ID.

引数

id	ID of the entity (inum bu default)

戻り値

entity instance

例外

ClientErrorException

                                                             {
                WebTarget resource = webTarget.path("read/{id}").resolveTemplate("id", id);
                return resource.request(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).get(entityClass);
        }

remove()

boolean org.gluu.oxtrust.api.client.util.AbstractClient< T >.remove ( String  inum )

inlineinherited

                                           {
                WebTarget resource = webTarget.path("/{inum}").resolveTemplate("inum", inum);
                System.out.println("Final Url:" + resource.getUri().toString());
                Response response = resource.request(MediaType.TEXT_PLAIN).delete();
                response.close();
                return response.getStatus() == HTTP_OK;
        }

searchGroups()

List<GluuGroup> org.gluu.oxtrust.api.client.group.GroupClient.searchGroups ( String  pattern, int  size  )

inline

                                                                      {
                WebTarget resource = webTarget.path("search").queryParam("pattern", pattern).queryParam("size", size);
                logger.debug("Final Url:" + resource.getUri().toString());
                GenericType<List<GluuGroup>> responseType = new GenericType<List<GluuGroup>>() {
                };
                return resource.request(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON).get(responseType);
        }

update()

boolean org.gluu.oxtrust.api.client.util.AbstractClient< T >.update ( T  requestEntity, String  id  )

inlineinherited

                                                          {
                WebTarget resource = webTarget.path("update/{id}").resolveTemplate("id", id);

                Response response = resource.request().put(Entity.entity(requestEntity, MediaType.APPLICATION_JSON));

                int code = response.getStatus();
                response.close();
                return code == HTTP_OK;
        }

メンバ詳解

client

Client org.gluu.oxtrust.api.client.util.AbstractClient< T >.client

protectedinherited

entityClass

Class<T> org.gluu.oxtrust.api.client.util.AbstractClient< T >.entityClass

protectedinherited

HTTP_OK

final int org.gluu.oxtrust.api.client.util.AbstractClient< T >.HTTP_OK = 200

staticinherited

logger

final Logger org.gluu.oxtrust.api.client.group.GroupClient.logger = LogManager.getLogger(GroupClient.class)

staticprivate

PATH

final String org.gluu.oxtrust.api.client.group.GroupClient.PATH = "/restv1/api/groups"

staticprivate

webTarget

WebTarget org.gluu.oxtrust.api.client.util.AbstractClient< T >.webTarget

protectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/client/src/main/java/org/gluu/oxtrust/api/client/group/GroupClient.java