com.afrozaar.wordpress.wpapi.v2

Class Client

java.lang.Object

com.afrozaar.wordpress.wpapi.v2.Client

All Implemented Interfaces:

Categories, Medias, Pages, PostMetas, Posts, Tags, Taxonomies, Terms, Users, Wordpress

public class Client
extends Object
implements Wordpress

Field Summary

Fields

Modifier and Type	Field and Description
String	baseUrl

Fields inherited from interface com.afrozaar.wordpress.wpapi.v2.Wordpress

CONTEXT

Fields inherited from interface com.afrozaar.wordpress.wpapi.v2.api.Taxonomies

CATEGORIES, CATEGORY, TAG, TAGS

Fields inherited from interface com.afrozaar.wordpress.wpapi.v2.api.Users

userMap

Fields inherited from interface com.afrozaar.wordpress.wpapi.v2.api.Tags

termIds

Constructor Summary

Constructors

Constructor and Description
Client(String baseUrl, String username, String password, boolean debug)
Client(String baseUrl, String username, String password, boolean debug, org.springframework.http.client.ClientHttpRequestFactory requestFactory)

Method Summary

Modifier and Type	Method and Description
Term	createCategory(Term categoryTerm)
Media	createMedia(Media media, org.springframework.core.io.Resource resource)
PostMeta	createMeta(Long postId, String key, String value)
Page	createPage(Page page, PostStatus status)
Post	createPost(Map<String,Object> postFields, PostStatus status)
Post	createPost(Post post, PostStatus status)
Term	createPostTag(Post post, Term tag)
Term	createTag(Term tagTerm)
User	createUser(User user, String username, String password)
List<Term>	deleteCategories(boolean force, Term... terms)
List<Term>	deleteCategories(Term... terms)
Term	deleteCategory(Term categoryTerm)
Term	deleteCategory(Term categoryTerm, boolean force)
boolean	deleteMedia(Media media)
boolean	deleteMedia(Media media, boolean force)
Page	deletePage(Page page)
Page	deletePage(Page page, boolean force)
Post	deletePost(Post post)
boolean	deletePostMeta(Long postId, Long metaId)
boolean	deletePostMeta(Long postId, Long metaId, boolean force)
Term	deletePostTag(Post post, Term tagTerm, boolean force)
Term	deleteTag(Term tagTerm) Does not make the call to wordpress with ?force=true.
Term	deleteTag(Term tagTerm, boolean force)
Term	deleteTerm(String taxonomy, Term term)
List<Term>	deleteTerms(String taxonomy, Term... terms)
User	deleteUser(User user)
List<Term>	getCategories()
Term	getCategory(Long id)
List<Media>	getMedia()
Media	getMedia(Long id)
Page	getPage(Long pageId)
Page	getPage(Long pageId, String context)
<T> PagedResponse<T>	getPagedResponse(String context, Class<T> typeRef, String... expandParams)
<T> PagedResponse<T>	getPagedResponse(URI uri, Class<T> typeRef)
Post	getPost(Long id)
Post	getPost(Long id, String context)
List<Media>	getPostMedias(Long postId)
PostMeta	getPostMeta(Long postId, Long metaId)
List<PostMeta>	getPostMetas(Long postId)
Term	getPostTag(Post post, Term tagTerm)
List<Term>	getPostTags(Post post)
Term	getTag(Long id)
List<Term>	getTags()
List<Taxonomy>	getTaxonomies()
Taxonomy	getTaxonomy(String slug)
Term	getTerm(String taxonomy, Long id)
List<Term>	getTerms(String taxonomy)
User	getUser(long userId)
User	getUser(long userId, String context)
List<User>	getUsers()
List<User>	getUsers(String contextType)
List<Link>	parseLinks(org.springframework.http.HttpHeaders headers)
<T> PagedResponse<T>	search(SearchRequest<T> search)
Post	setPostFeaturedImage(Long postId, Media media)
<T> PagedResponse<T>	traverse(PagedResponse<T> response, Function<PagedResponse<?>,String> direction)
Media	updateMedia(Media media)
Page	updatePage(Page page)
Post	updatePost(Post post) PUT /post/{id}
Post	updatePostField(Long postId, String field, Object value)
PostMeta	updatePostMeta(Long postId, Long metaId, String key, String value)
PostMeta	updatePostMetaValue(Long postId, Long metaId, String value)
Term	updateTag(Term tag)
Term	updateTerm(String taxonomy, Term term)
User	updateUser(User user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.afrozaar.wordpress.wpapi.v2.api.Posts

list

Field Detail

baseUrl

public final String baseUrl

Constructor Detail

Client

public Client(String baseUrl,
              String username,
              String password,
              boolean debug)

Client

public Client(String baseUrl,
              String username,
              String password,
              boolean debug,
              org.springframework.http.client.ClientHttpRequestFactory requestFactory)

Method Detail

createPost

public Post createPost(Map<String,Object> postFields,
                       PostStatus status)
                throws PostCreateException

Specified by:

createPost in interface Posts

Parameters:

postFields - Map<String, Object>

Returns:

Created Post

Throws:

PostCreateException

See Also:

Create a Post - v1 documentation

     status - Post status of the post:
     * draft,
     * publish,
     * pending,
     * future,
     * private
      or any custom registered status.
     If providing a status of future, you must specify a date in order for the post to be published as expected.
     Default is draft. (string) optional
 

createPost

public Post createPost(Post post,
                       PostStatus status)
                throws PostCreateException

Specified by:

createPost in interface Posts

Throws:

PostCreateException

getPost

public Post getPost(Long id)
             throws PostNotFoundException

Specified by:

getPost in interface Posts

Throws:

PostNotFoundException

getPost

public Post getPost(Long id,
                    String context)
             throws PostNotFoundException

Specified by:

getPost in interface Posts

Throws:

PostNotFoundException

updatePost

public Post updatePost(Post post)

Description copied from interface: Posts

 PUT /post/{id}
 

Specified by:

updatePost in interface Posts

updatePostField

public Post updatePostField(Long postId,
                            String field,
                            Object value)

Specified by:

updatePostField in interface Posts

deletePost

public Post deletePost(Post post)

Specified by:

deletePost in interface Posts

search

public <T> PagedResponse<T> search(SearchRequest<T> search)

Specified by:

search in interface Wordpress

createMedia

public Media createMedia(Media media,
                         org.springframework.core.io.Resource resource)
                  throws WpApiParsedException

Specified by:

createMedia in interface Medias

Throws:

WpApiParsedException

setPostFeaturedImage

public Post setPostFeaturedImage(Long postId,
                                 Media media)

Specified by:

setPostFeaturedImage in interface Medias

getPostMedias

public List<Media> getPostMedias(Long postId)

Specified by:

getPostMedias in interface Medias

getMedia

public List<Media> getMedia()

Specified by:

getMedia in interface Medias

getMedia

public Media getMedia(Long id)

Specified by:

getMedia in interface Medias

updateMedia

public Media updateMedia(Media media)

Specified by:

updateMedia in interface Medias

deleteMedia

public boolean deleteMedia(Media media,
                           boolean force)

Specified by:

deleteMedia in interface Medias

deleteMedia

public boolean deleteMedia(Media media)

Specified by:

deleteMedia in interface Medias

createMeta

public PostMeta createMeta(Long postId,
                           String key,
                           String value)

Specified by:

createMeta in interface PostMetas

getPostMetas

public List<PostMeta> getPostMetas(Long postId)

Specified by:

getPostMetas in interface PostMetas

getPostMeta

public PostMeta getPostMeta(Long postId,
                            Long metaId)

Specified by:

getPostMeta in interface PostMetas

updatePostMetaValue

public PostMeta updatePostMetaValue(Long postId,
                                    Long metaId,
                                    String value)

Specified by:

updatePostMetaValue in interface PostMetas

updatePostMeta

public PostMeta updatePostMeta(Long postId,
                               Long metaId,
                               String key,
                               String value)

Specified by:

updatePostMeta in interface PostMetas

deletePostMeta

public boolean deletePostMeta(Long postId,
                              Long metaId)

Specified by:

deletePostMeta in interface PostMetas

deletePostMeta

public boolean deletePostMeta(Long postId,
                              Long metaId,
                              boolean force)

Specified by:

deletePostMeta in interface PostMetas

getTaxonomies

public List<Taxonomy> getTaxonomies()

Specified by:

getTaxonomies in interface Taxonomies

getTaxonomy

public Taxonomy getTaxonomy(String slug)

Specified by:

getTaxonomy in interface Taxonomies

getTerms

public List<Term> getTerms(String taxonomy)

Specified by:

getTerms in interface Terms

getTerm

public Term getTerm(String taxonomy,
                    Long id)
             throws TermNotFoundException

Specified by:

getTerm in interface Terms

Throws:

TermNotFoundException

updateTerm

public Term updateTerm(String taxonomy,
                       Term term)

Specified by:

updateTerm in interface Terms

deleteTerm

public Term deleteTerm(String taxonomy,
                       Term term)
                throws TermNotFoundException

Specified by:

deleteTerm in interface Terms

Throws:

TermNotFoundException

deleteTerms

public List<Term> deleteTerms(String taxonomy,
                              Term... terms)

Specified by:

deleteTerms in interface Terms

createTag

public Term createTag(Term tagTerm)
               throws WpApiParsedException

Specified by:

createTag in interface Tags

Throws:

WpApiParsedException

getTags

public List<Term> getTags()

Specified by:

getTags in interface Tags

getTag

public Term getTag(Long id)
            throws TermNotFoundException

Specified by:

getTag in interface Tags

Throws:

TermNotFoundException

deleteTag

public Term deleteTag(Term tagTerm)
               throws TermNotFoundException

Description copied from interface: Tags

Does not make the call to wordpress with ?force=true. If tag trashing is not supported, an exception will be thrown.

Specified by:

deleteTag in interface Tags

Throws:

TermNotFoundException

deleteTag

public Term deleteTag(Term tagTerm,
                      boolean force)
               throws TermNotFoundException

Specified by:

deleteTag in interface Tags

Throws:

TermNotFoundException

createPostTag

public Term createPostTag(Post post,
                          Term tag)
                   throws WpApiParsedException

Specified by:

createPostTag in interface Tags

Throws:

WpApiParsedException

getPostTags

public List<Term> getPostTags(Post post)

Specified by:

getPostTags in interface Tags

deletePostTag

public Term deletePostTag(Post post,
                          Term tagTerm,
                          boolean force)
                   throws TermNotFoundException

Specified by:

deletePostTag in interface Tags

Throws:

TermNotFoundException

getPostTag

public Term getPostTag(Post post,
                       Term tagTerm)
                throws TermNotFoundException

Specified by:

getPostTag in interface Tags

Throws:

TermNotFoundException

updateTag

public Term updateTag(Term tag)

Specified by:

updateTag in interface Tags

getCategory

public Term getCategory(Long id)

Specified by:

getCategory in interface Categories

getCategories

public List<Term> getCategories()

Specified by:

getCategories in interface Categories

createCategory

public Term createCategory(Term categoryTerm)

Specified by:

createCategory in interface Categories

deleteCategory

public Term deleteCategory(Term categoryTerm)
                    throws TermNotFoundException

Specified by:

deleteCategory in interface Categories

Throws:

TermNotFoundException

deleteCategory

public Term deleteCategory(Term categoryTerm,
                           boolean force)
                    throws TermNotFoundException

Specified by:

deleteCategory in interface Categories

Throws:

TermNotFoundException

deleteCategories

public List<Term> deleteCategories(Term... terms)

Specified by:

deleteCategories in interface Categories

deleteCategories

public List<Term> deleteCategories(boolean force,
                                   Term... terms)

Specified by:

deleteCategories in interface Categories

createPage

public Page createPage(Page page,
                       PostStatus status)

Specified by:

createPage in interface Pages

getPage

public Page getPage(Long pageId)
             throws PageNotFoundException

Specified by:

getPage in interface Pages

Throws:

PageNotFoundException

getPage

public Page getPage(Long pageId,
                    String context)

Specified by:

getPage in interface Pages

updatePage

public Page updatePage(Page page)

Specified by:

updatePage in interface Pages

deletePage

public Page deletePage(Page page)

Specified by:

deletePage in interface Pages

deletePage

public Page deletePage(Page page,
                       boolean force)

Specified by:

deletePage in interface Pages

getUsers

public List<User> getUsers()

Specified by:

getUsers in interface Users

getUsers

public List<User> getUsers(String contextType)

Specified by:

getUsers in interface Users

createUser

public User createUser(User user,
                       String username,
                       String password)
                throws WpApiParsedException

Specified by:

createUser in interface Users

Throws:

WpApiParsedException

getUser

public User getUser(long userId)
             throws UserNotFoundException

Specified by:

getUser in interface Users

Throws:

UserNotFoundException

getUser

public User getUser(long userId,
                    String context)
             throws UserNotFoundException

Specified by:

getUser in interface Users

Throws:

UserNotFoundException

deleteUser

public User deleteUser(User user)

Specified by:

deleteUser in interface Users

updateUser

public User updateUser(User user)

Specified by:

updateUser in interface Users

getPagedResponse

public <T> PagedResponse<T> getPagedResponse(String context,
                                             Class<T> typeRef,
                                             String... expandParams)

Specified by:

getPagedResponse in interface Wordpress

getPagedResponse

public <T> PagedResponse<T> getPagedResponse(URI uri,
                                             Class<T> typeRef)

Specified by:

getPagedResponse in interface Wordpress

traverse

public <T> PagedResponse<T> traverse(PagedResponse<T> response,
                                     Function<PagedResponse<?>,String> direction)

Specified by:

traverse in interface Wordpress

parseLinks

public List<Link> parseLinks(org.springframework.http.HttpHeaders headers)